A Python package & command-line tool to gather text on the Web

Usage examples

url = "https://zh.wikipedia.org/wiki/%E5%94%90%E5%AE%8B%E5%85%AB%E5%A4%A7%E5%AE%B6"
downloaded = fetch_url(url)
format = "txt"
result = trafilatura.extract(downloaded, url, output_format=format, include_images=True,include_formatting=True)
with open(f"test.{format}", "w", encoding="utf-8") as f:
    f.write(result)

output example

• qq-news.md
• wikipedia-唐宋八大家.md

Update 2023/08/31

• The image parsing function has been added, which supports parsing images from web pages and outputting them in the correct markdown format.
• The issue of table disarray when converting XML to markdown format has been resolved.

Description

Trafilatura is a Python package and command-line tool designed to gather text on the Web. It includes discovery, extraction and text processing components. Its main applications are web crawling, downloads, scraping, and extraction of main texts, metadata and comments. It aims at staying handy and modular: no database is required, the output can be converted to various commonly used formats.

Going from raw HTML to essential parts can alleviate many problems related to text quality, first by avoiding the noise caused by recurring elements (headers, footers, links/blogroll etc.) and second by including information such as author and date in order to make sense of the data. The extractor tries to strike a balance between limiting noise (precision) and including all valid parts (recall). It also has to be robust and reasonably fast, it runs in production on millions of documents.

This tool can be useful for quantitative research in corpus linguistics, natural language processing, computational social science and beyond: it is relevant to anyone interested in data science, information extraction, text mining, and scraping-intensive use cases like search engine optimization, business analytics or information security.

Features

• Web crawling and text discovery:

  • Focused crawling and politeness rules
  • Support for sitemaps (TXT, XML) and feeds (ATOM, JSON, RSS)
  • URL management (blacklists, filtering and de-duplication)

• Seamless and parallel processing, online and offline:

  • URLs, HTML files or parsed HTML trees usable as input
  • Efficient and polite processing of download queues
  • Conversion of previously downloaded files

• Robust and efficient extraction:

  • Main text (with LXML, common patterns and generic algorithms: jusText, fork of readability-lxml)
  • Metadata (title, author, date, site name, categories and tags)
  • Formatting and structural elements: paragraphs, titles, lists, quotes, code, line breaks, in-line text formatting
  • Comments (if applicable)

• Output formats:

  • Text (minimal formatting or Markdown)
  • CSV (with metadata, tab-separated values)
  • JSON (with metadata)
  • XML (with metadata, text formatting and page structure) and TEI-XML

• Optional add-ons:

  • Language detection on extracted content
  • Graphical user interface (GUI)
  • Speed optimizations

Evaluation and alternatives

For more detailed results see the benchmark and evaluation script. 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.

750 documents, 2236 text & 2250 boilerplate segments (2022-05-18), Python 3.8
Python Package	Precision	Recall	Accuracy	F-Score	Diff.
html_text 0.5.2	0.529	0.958	0.554	0.682	2.2x
inscriptis 2.2.0 (html to txt)	0.534	0.959	0.563	0.686	3.5x
newspaper3k 0.2.8	0.895	0.593	0.762	0.713	12x
justext 3.0.0 (custom)	0.865	0.650	0.775	0.742	5.2x
boilerpy3 1.0.6 (article mode)	0.814	0.744	0.787	0.777	4.1x
baseline (text markup)	0.757	0.827	0.781	0.790	1x
goose3 3.1.9	0.934	0.690	0.821	0.793	22x
readability-lxml 0.8.1	0.891	0.729	0.820	0.801	5.8x
news-please 1.5.22	0.898	0.734	0.826	0.808	61x
readabilipy 0.2.0	0.877	0.870	0.874	0.874	248x
trafilatura 1.2.2 (standard)	0.914	0.904	0.910	0.909	7.1x

Other evaluations:

• Most efficient open-source library in ScrapingHub's article extraction benchmark
• Best overall tool according to Gaël Lejeune & Adrien Barbaresi, Bien choisir son outil d'extraction de contenu à partir du Web (2020, PDF, French)

Usage and documentation

For more information please refer to the documentation:

• Installation
• Usage: On the command-line, With Python, With R
• Core Python functions
• Python Notebook Trafilatura Overview
• Tutorials

For video tutorials see this Youtube playlist:

• Web scraping how-tos and tutorials

License

Trafilatura is distributed under the GNU General Public License v3.0. If you wish to redistribute this library but feel bounded by the license conditions please try interacting at arms length, multi-licensing with compatible licenses, or contacting me.

See also GPL and free software licensing: What's in it for business?

Context

Contributing

Contributions are welcome! See CONTRIBUTING.md for more information. Bug reports can be filed on the dedicated page.

Many thanks to the contributors who submitted features and bugfixes!

Roadmap

For planned enhancements and relevant milestones see issues page.

Author

This effort is part of methods to derive information from web documents in order to build text databases for research (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.

• Barbaresi, A. Trafilatura: A Web Scraping Library and Command-Line Tool for Text Discovery and Extraction, Proceedings of ACL/IJCNLP 2021: System Demonstrations, 2021, p. 122-131.
• Barbaresi, A. "Generic Web Content Extraction with Open-Source Software", Proceedings of KONVENS 2019, Kaleidoscope Abstracts, 2019.
• Barbaresi, A. "Efficient construction of metadata-enhanced web corpora", Proceedings of the 10th Web as Corpus Workshop (WAC-X), 2016.

@inproceedings{barbaresi-2021-trafilatura,
  title = {{Trafilatura: A Web Scraping Library and Command-Line Tool for Text Discovery and Extraction}},
  author = "Barbaresi, Adrien",
  booktitle = "Proceedings of the Joint Conference of the 59th Annual Meeting of the Association for Computational Linguistics and the 11th International Joint Conference on Natural Language Processing: System Demonstrations",
  pages = "122--131",
  publisher = "Association for Computational Linguistics",
  url = "https://aclanthology.org/2021.acl-demo.15",
  year = 2021,
}

You can contact me via my contact page or on GitHub.

Software ecosystem

Trafilatura: Italian word for wire drawing.

Known uses of the software.

Corresponding posts on Bits of Language (blog).