scotteh/php-goose

Readability / Html Content / Article Extractor & Web Scrapping library written in PHP

Sunday, July 1, 2018
by scotteh
Repository
17 Watchers
270 Stars
18,918 Installations

PHP
2 Dependents
0 Suggesters
78 Forks
4 Open issues
21 Versions
8 % Grown

The README.md

PHP Goose - Article Extractor

Note

This repository has been archived as of 2023-09-05., _(*1)

Intro

PHP Goose is a port of Goose originally developed in Java and converted to Scala by GravityLabs. Portions have also been ported from the Python port python-goose. Its mission is to take any news article or article type web page and not only extract what is the main body of the article but also all metadata and most probable image candidate., _(*2)

The extraction goal is to try and get the purest extraction from the beginning of the article for servicing flipboard/pulse type applications that need to show the first snippet of a web article along with an image., _(*3)

Goose will try to extract the following information:, _(*4)

Main text of an article
Main image of article
Any YouTube/Vimeo movies embedded in article
Meta Description
Meta tags
Publish Date

The PHP version was rewritten by:, _(*5)

Andrew Scott

Requirement

PHP 7.1 or later
PSR-4 compatible autoloader

The older 0.x versions with PHP 5.5+ support are still available under releases., _(*6)

Install

This library is designed to be installed via Composer., _(*7)

Add the dependency into your projects composer.json., _(*8)

{
  "require": {
    "scotteh/php-goose": "^1.0"
  }
}

Download the composer.phar ``` bash curl -sS https://getcomposer.org/installer | php, _(*9)


Install the library.
``` bash
php composer.phar install

Autoloading

This library requires an autoloader, if you aren't already using one you can include Composers autoloader., _(*10)

``` php require('vendor/autoload.php');, _(*11)


## Usage

``` php
use \Goose\Client as GooseClient;

$goose = new GooseClient();
$article = $goose->extractContent('http://url.to/article');

$title = $article->getTitle();
$metaDescription = $article->getMetaDescription();
$metaKeywords = $article->getMetaKeywords();
$canonicalLink = $article->getCanonicalLink();
$domain = $article->getDomain();
$tags = $article->getTags();
$links = $article->getLinks();
$videos = $article->getVideos();
$articleText = $article->getCleanedArticleText();
$entities = $article->getPopularWords();
$image = $article->getTopImage();
$allImages = $article->getAllImages();

Configuration

All config options are not required and are optional. Default (fallback) values have been used below., _(*12)

``` php use \Goose\Client as GooseClient;, _(*13)

$goose = new GooseClient([ // Language - Selects common word dictionary // Supported languages (ISO 639-1): // ar, cs, da, de, en, es, fi, fr, hu, id, it, ja, // ko, nb, nl, no, pl, pt, ru, sv, vi, zh 'language' => 'en', // Minimum image size (bytes) 'image_min_bytes' => 4500, // Maximum image size (bytes) 'image_max_bytes' => 5242880, // Minimum image size (pixels) 'image_min_width' => 120, // Maximum image size (pixels) 'image_min_height' => 120, // Fetch best image 'image_fetch_best' => true, // Fetch all images 'image_fetch_all' => false, // Guzzle configuration - All values are passed directly to Guzzle // See: http://guzzle.readthedocs.io/en/stable/request-options.html 'browser' => [ 'timeout' => 60, 'connect_timeout' => 30 ] ]); ```, _(*14)

Licensing

PHP Goose is licensed by Gravity.com under the Apache 2.0 license, see the LICENSE file for more details., _(*15)

The Versions

01/07 2018

dev-master

9999999-dev https://github.com/scotteh/php-goose

Readability / Html Content / Article Extractor & Web Scrapping library written in PHP

library php-goose

Readability / Html Content / Article Extractor & Web Scrapping library written in PHP

scotteh/php-goose

The README.md

PHP Goose - Article Extractor

Note

Intro

Requirement

Install

Autoloading

Configuration

Licensing

The Versions

dev-master

The Requires

The Development Requires

by Andrew Scott

1.0.7

The Requires

The Development Requires

by Andrew Scott

1.0.6

The Requires

The Development Requires

by Andrew Scott

1.0.5

The Requires

The Development Requires

by Andrew Scott

1.0.4

The Requires

The Development Requires

by Andrew Scott

dev-doc

The Requires

The Development Requires

by Andrew Scott

1.0.3

The Requires

The Development Requires

by Andrew Scott

1.0.2

The Requires

The Development Requires

by Andrew Scott

1.0.1

The Requires

The Development Requires

by Andrew Scott

1.0.0

The Requires

The Development Requires

by Andrew Scott

0.6.4

The Requires

The Development Requires

by Andrew Scott

0.6.3

The Requires

The Development Requires

by Andrew Scott

dev-php7.1

The Requires

The Development Requires

by Andrew Scott

0.6.2

The Requires

The Development Requires

by Andrew Scott

0.6.1

The Requires

The Development Requires

by Andrew Scott

0.6.0

The Requires

The Development Requires

by Andrew Scott

0.5.0

The Requires

The Development Requires