.. _api:

Goose3 API
===============================================================================

Goose3
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. autoclass:: goose3.Goose
    :members:


.. _configdocs:

Configuration
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Configuration options to change how and what goose3 extracts and parses.

.. autoclass:: goose3.Configuration
    :members:

Configuration Helper Classes
-------------------------------------------------------------------------------

.. autoclass:: goose3.configuration.ArticleContextPattern

.. autoclass:: goose3.configuration.AuthorPattern

.. autoclass:: goose3.configuration.PublishDatePattern


.. _articledocs:

Article
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

The result of a goose3 extraction is to return an Article object that
contains the results of the parsing process.

.. autoclass:: goose3.Article
    :members:


Image
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. autoclass:: goose3.Image
    :members:


Video
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. autoclass:: goose3.Video
    :members: