Metadata-Version: 2.1
Name: trafilatura
Version: 0.7.0
Summary: Downloads web pages, scrapes main text and comments while preserving some structure, and converts to TXT, CSV, JSON and XML
Home-page: http://github.com/adbar/trafilatura
Author: Adrien Barbaresi
Author-email: barbaresi@bbaw.de
License: GPLv3+
Project-URL: Documentation, https://trafilatura.readthedocs.io
Project-URL: Source, https://github.com/adbar/trafilatura
Project-URL: Coverage, https://codecov.io/github/adbar/trafilatura
Project-URL: Tracker, https://github.com/adbar/trafilatura/issues
Description: trafilatura: manage URLs and scrape main text and metadata
        ==========================================================
        
        .. image:: https://img.shields.io/pypi/v/trafilatura.svg
            :target: https://pypi.python.org/pypi/trafilatura
            :alt: Python package
        
        .. image:: https://img.shields.io/pypi/pyversions/trafilatura.svg
            :target: https://pypi.python.org/pypi/trafilatura
            :alt: Python versions
        
        .. image:: https://readthedocs.org/projects/trafilatura/badge/?version=latest
            :target: http://trafilatura.readthedocs.org/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/travis/adbar/trafilatura.svg
            :target: https://travis-ci.org/adbar/trafilatura
            :alt: Travis build status
        
        .. image:: https://img.shields.io/codecov/c/github/adbar/trafilatura.svg
            :target: https://codecov.io/gh/adbar/trafilatura
            :alt: Code Coverage
        
        .. image:: https://static.pepy.tech/badge/trafilatura/month
            :target: https://pepy.tech/project/trafilatura
            :alt: Downloads
        
        |
        
        .. image:: docs/trafilatura-demo.gif
            :alt: Demo as GIF image
            :align: center
            :width: 85%
            :target: https://trafilatura.readthedocs.org/
        
        
        Description
        -----------
        
        *Trafilatura* is a Python package and command-line tool which seamlessly downloads, parses, and scrapes web page data: it can extract metadata, main body text and comments while preserving parts of the text formatting and page structure. The output can be converted to different formats.
        
        Distinguishing between a whole page and the page's essential parts can help to alleviate many quality problems related to web text processing, by dealing with the noise caused by recurring elements (headers and footers, ads, links/blogroll, etc.).
        
        The extractor aims to be precise enough in order not to  miss texts or to discard valid documents. In addition, it must be robust, but also reasonably fast. With these objectives in mind, Trafilatura is designed to run in production on millions of web documents. It is based on `lxml <http://lxml.de/>`_ as well as `readability <https://github.com/buriy/python-readability>`_ and `jusText <http://corpus.tools/wiki/Justext>`_ as fallback.
        
        
        Features
        ~~~~~~~~
        
        - Seamless parallelized online and offline processing:
           - Download and conversion utilities included
           - URLs, HTML files or parsed HTML trees as input
        - Robust and efficient extraction:
            - Main text and/or comments
            - Structural elements preserved: paragraphs, titles, lists, quotes, code, line breaks, in-line text formatting
            - Extraction of metadata (title, author, date, site name, categories and tags)
        - Several output formats supported:
           - Plain text (minimal formatting)
           - CSV (with metadata, `tab-separated values <https://en.wikipedia.org/wiki/Tab-separated_values>`_)
           - JSON (with metadata)
           - XML (for metadata and structure) and `TEI-XML <https://tei-c.org/>`_
        - Link discovery and URL lists:
            - Support for sitemaps and ATOM/RSS feeds
            - Efficient and polite processing of URL queues
            - Blacklisting
        - Optional language detection on extracted content
        
        
        Evaluation and alternatives
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        For more detailed results see the `evaluation page <https://github.com/adbar/trafilatura/blob/master/docs/evaluation.rst>`_ and `evaluation script <https://github.com/adbar/trafilatura/blob/master/tests/comparison.py>`_. To reproduce the tests just clone the repository, install all necessary packages and run the evaluation script with the data provided in the *tests* directory.
        
        =============================== =========  ========== ========= ========= ======
        500 documents, 1487 text and 1496 boilerplate segments (2020-11-06)
        --------------------------------------------------------------------------------
        Python Package                  Precision  Recall     Accuracy  F-Score   Diff.
        =============================== =========  ========== ========= ========= ======
        justext 2.2.0 (tweaked)         0.870      0.584      0.749     0.699     6.1x
        newspaper3k 0.2.8               0.921      0.574      0.763     0.708     12.9x
        goose3 3.1.6                    **0.950**  0.629      0.799     0.757     19.0x
        boilerpy3 1.0.2 (article mode)  0.851      0.696      0.788     0.766     4.8x
        *baseline (text markup)*        0.746      0.804      0.766     0.774     **1x**
        dragnet 2.0.4                   0.906      0.689      0.810     0.783     3.1x
        readability-lxml 0.8.1          0.917      0.716      0.826     0.804     5.9x
        news-please 1.5.13              0.923      0.711      0.827     0.804     184x
        trafilatura 0.6.0               0.924      0.849      0.890     0.885     3.9x
        trafilatura 0.6.0 (+ fallbacks) 0.933      **0.877**  **0.907** **0.904** 8.4x
        =============================== =========  ========== ========= ========= ======
        
        **External evaluations:**
        
        - Most efficient open-source library in *ScrapingHub*'s `article extraction benchmark <https://github.com/scrapinghub/article-extraction-benchmark>`_.
        - Best overall tool according to Gaël Lejeune & Adrien Barbaresi, `Bien choisir son outil d'extraction de contenu à partir du Web <https://hal.archives-ouvertes.fr/hal-02768510v3/document>`_ (2020, PDF, French).
        
        
        Usage and documentation
        -----------------------
        
        - `Installation <https://trafilatura.readthedocs.io/en/latest/installation.html>`_
        - Usage
           - `On the command-line <https://trafilatura.readthedocs.io/en/latest/usage-cli.html>`_
           - `With Python <https://trafilatura.readthedocs.io/en/latest/usage-python.html>`_
           - `Core Python functions <https://trafilatura.readthedocs.io/en/latest/corefunctions.html>`_
        - `Tutorials <https://trafilatura.readthedocs.io/en/latest/tutorials.html>`_
        - `Evaluation <https://trafilatura.readthedocs.io/en/latest/evaluation.html>`_
        
        For further information please refer to the `documentation <https://trafilatura.readthedocs.io>`_.
        
        
        License
        -------
        
        *trafilatura* is distributed under the `GNU General Public License v3.0 <https://github.com/adbar/trafilatura/blob/master/LICENSE>`_. If you wish to redistribute this library but feel bounded by the license conditions please try interacting `at arms length <https://www.gnu.org/licenses/gpl-faq.html#GPLInProprietarySystem>`_, `multi-licensing <https://en.wikipedia.org/wiki/Multi-licensing>`_ with `compatible licenses <https://en.wikipedia.org/wiki/GNU_General_Public_License#Compatibility_and_multi-licensing>`_, or `contacting me <https://github.com/adbar/trafilatura#author>`_.
        
        See also `GPL and free software licensing: What's in it for business? <https://www.techrepublic.com/blog/cio-insights/gpl-and-free-software-licensing-whats-in-it-for-business/>`_
        
        
        Roadmap
        ~~~~~~~
        
        -  [-] Duplicate detection at sentence, paragraph and document level using a least recently used (LRU) cache
        -  [-] URL lists and document management
        -  [-] Configuration and extraction parameters
        -  [ ] Interaction with web archives (notably WARC format)
        -  [ ] Integration of natural language processing tools
        
        
        Contributing
        ~~~~~~~~~~~~
        
        `Contributions <https://github.com/adbar/trafilatura/blob/master/CONTRIBUTING.md>`_ are welcome!
        
        Feel free to file issues on the `dedicated page <https://github.com/adbar/trafilatura/issues>`_. Thanks to the `contributors <https://github.com/adbar/trafilatura/graphs/contributors>`_ who submitted features and bugfixes!
        
        
        Author
        ------
        
        This effort is part of methods to derive information from web documents in order to build `text databases for research <https://www.dwds.de/d/k-web>`_ (chiefly linguistic analysis and natural language processing). Extracting and pre-processing web texts to the exacting standards of scientific research presents a substantial challenge for those who conduct such research. Web corpus construction involves numerous design decisions, and this software package can help facilitate text data collection and enhance corpus quality.
        
        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3460969.svg
           :target: https://doi.org/10.5281/zenodo.3460969
        
        -  Barbaresi, A. "`Generic Web Content Extraction with Open-Source Software <https://hal.archives-ouvertes.fr/hal-02447264/document>`_", Proceedings of KONVENS 2019, Kaleidoscope Abstracts, 2019.
        -  Barbaresi, A. "`Efficient construction of metadata-enhanced web corpora <https://hal.archives-ouvertes.fr/hal-01371704v2/document>`_", Proceedings of the `10th Web as Corpus Workshop (WAC-X) <https://www.sigwac.org.uk/wiki/WAC-X>`_, 2016.
        
        You can contact me via my `contact page <https://adrien.barbaresi.eu/>`_ or `GitHub <https://github.com/adbar>`_.
        
        
        Going further
        -------------
        
        **Online documentation:** `trafilatura.readthedocs.io <https://trafilatura.readthedocs.io/>`_
        
        *Trafilatura*: `Italian word <https://en.wiktionary.org/wiki/trafilatura>`_ for `wire drawing <https://en.wikipedia.org/wiki/Wire_drawing>`_.
        
        -  In order to gather web documents, it can be useful to download the portions of a website programmatically, here is `how to use sitemaps to crawl websites <http://adrien.barbaresi.eu/blog/using-sitemaps-crawl-websites.html>`_
        
        -  `Content von Webseiten laden mit Trafilatura <https://www.youtube.com/watch?v=9RPrVE0hHgI>`_ (Tutorial video in German by Simon Meier-Vieracker)
        
        -  `Download von Web-Daten <https://www.bubenhofer.com/korpuslinguistik/kurs/index.php?id=eigenes_wwwdownload.html>`_ & `Daten aufbereiten und verwalten <https://www.bubenhofer.com/korpuslinguistik/kurs/index.php?id=eigenes_aufbereitenXML.html>`_ (Tutorials in German by Noah Bubenhofer)
        
        
Keywords: html2text,nlp,scraper,tei-xml,text-extraction,webscraping,web-scraping
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.4
Provides-Extra: all
