Skip to main content

Fast and robust extraction of original and updated publication dates from web pages.

Project description

Python package Python versions Documentation Status Travis build status Code Coverage Downloads

Code:https://github.com/adbar/htmldate
Documentation:https://htmldate.readthedocs.io
Issue tracker:https://github.com/adbar/htmldate/issues

Demo as GIF image

Find original and updated publication dates of any web page. From the command-line or within Python, all the steps needed from web page download to HTML parsing, scraping, and text analysis are included.

In a nutshell, with Python:

>>> from htmldate import find_date
>>> find_date('http://blog.python.org/2016/12/python-360-is-now-available.html')
'2016-12-23'
>>> find_date('https://netzpolitik.org/2016/die-cider-connection-abmahnungen-gegen-nutzer-von-creative-commons-bildern/', original_date=True)
'2016-06-23'

On the command-line:

$ htmldate -u http://blog.python.org/2016/12/python-360-is-now-available.html
'2016-12-23'

Features

htmldate finds original and updated publication dates of web pages using heuristics on HTML code and linguistic patterns. URLs, HTML files, or HTML trees are given as input. It provides following ways to date a HTML document:

  1. Markup in header: common patterns are used to identify relevant elements (e.g. link and meta elements) including Open Graph protocol attributes and a large number of CMS idiosyncrasies
  2. HTML code: The whole document is then searched for structural markers: abbr and time elements as well as a series of attributes (e.g. postmetadata)
  3. Bare HTML content: A series of heuristics is run on text and markup:
  • in fast mode the HTML page is cleaned and precise patterns are targeted
  • in extensive mode all potential dates are collected and a disambiguation algorithm determines the best one

The output is thouroughly verified in terms of plausibility and adequateness and the library outputs a date string, corresponding to either the last update or the original publishing statement (the default), in the desired format (defaults to ISO 8601 YMD format).

  • Should be compatible with all recent versions of Python (currently 3.4 to 3.9)
  • Designed to be computationally efficient and used in production on millions of documents
  • Batch processing of a list of URLs
  • Switch between original and updated date

Markup-based extraction is multilingual by nature, text-based refinements for better coverage currently support German, English and Turkish.

Performance

225 web pages containing identifiable dates (as of 2020-11-03)
Python Package Precision Recall Accuracy F-Score Time
articleDateExtractor 0.20 0.817 0.635 0.556 0.714 3.5x
date_guesser 2.1.4 0.809 0.553 0.489 0.657 21x
goose3 3.1.6 0.887 0.441 0.418 0.589 7.7x
htmldate[all] 0.7.2 (fast) 0.899 0.917 0.831 0.908 1x
htmldate[all] 0.7.2 (extensive) 0.893 1.000 0.893 0.944 1.6x
newspaper3k 0.2.8 0.888 0.407 0.387 0.558 40x
news-please 1.5.13 0.823 0.660 0.578 0.732 31x

For complete results and explanations see the evaluation page.

Installation

This Python package is tested on Linux, macOS and Windows systems, it is compatible with Python 3.4 upwards. It is available on the package repository PyPI and can notably be installed with pip or pipenv:

$ pip install htmldate # pip3 install on systems where both Python 2 and 3 are installed
$ pip install --upgrade htmldate # to make sure you have the latest version
$ pip install git+https://github.com/adbar/htmldate.git # latest available code (see build status above)

Additional libraries can be installed to enhance efficiency: cchardet and ciso8601 (for speed). They may not work on all platforms and have thus been singled out although installation is recommended:

$ pip install htmldate[speed] # install with additional functionality

You can also install or update the packages separately, htmldate will detect which ones are present on your system and opt for the best available combination.

For infos on dependency management of Python packages see this discussion thread

With Python

>>> from htmldate import find_date
>>> find_date('http://blog.python.org/2016/12/python-360-is-now-available.html')
'2016-12-23'

Complete screening of the document with the extensive_search parameter:

>>> find_date('https://creativecommons.org/about/')
'2017-08-11' # has been updated since
>>> find_date('https://creativecommons.org/about/', extensive_search=False)
>>>

Already parsed HTML (that is a LXML tree object):

# simple HTML document as string
>>> htmldoc = '<html><body><span class="entry-date">July 12th, 2016</span></body></html>'
>>> find_date(htmldoc)
'2016-07-12'
# parsed LXML tree
>>> from lxml import html
>>> mytree = html.fromstring('<html><body><span class="entry-date">July 12th, 2016</span></body></html>')
>>> find_date(mytree)
'2016-07-12'

Change the output to a format known to Python’s datetime module, the default being %Y-%m-%d:

>>> find_date('https://www.gnu.org/licenses/gpl-3.0.en.html', outputformat='%d %B %Y')
'18 November 2016' # may have changed since

Although the time delta between original publication and “last modified” info is usually a matter of hours or days, it can be useful to prioritize the original publication date:

>>> find_date('https://netzpolitik.org/2016/die-cider-connection-abmahnungen-gegen-nutzer-von-creative-commons-bildern/', original_date=True) # modified behavior
'2016-06-23'

On the command-line

$ htmldate -u http://blog.python.org/2016/12/python-360-is-now-available.html
'2016-12-23'
$ htmldate --help
htmldate [-h] [-v] [-f] [--original] [-min MINDATE] [-max MAXDATE] [-i INPUTFILE] [-u URL]
optional arguments:
-h, --help show this help message and exit
-v, --verbose increase output verbosity
-f, --fast fast mode: disable extensive search
--original original date prioritized
-min, --mindate MINDATE
 earliest acceptable date (YYYY-MM-DD)
-max, --maxdate MAXDATE
 latest acceptable date (YYYY-MM-DD)
-i, --inputfile INPUTFILE
 name of input file for batch processing (similar to wget -i)
-u, --URL URL custom URL download

The batch mode -i takes one URL per line as input and returns one result per line in tab-separated format:

$ htmldate --fast -i list-of-urls.txt

License

htmldate 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?

Going further

Online documentation: htmldate.readthedocs.io

If the date is nowhere to be found, it might be worth considering carbon dating the web page, however this is computationally expensive. In addition, datefinder features pattern-based date extraction for texts written in English.

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. There are web pages for which neither the URL nor the server response provide a reliable way to find out when a document was published or modified. For more information:

JOSS article Zenodo archive

You can contact me via my contact page or GitHub.

Contributing

Contributions are welcome!

Feel free to file issues on the dedicated page. Thanks to the contributors who submitted features and bugfixes!

Kudos to the following software libraries:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for htmldate, version 0.8.1
Filename, size File type Python version Upload date Hashes
Filename, size htmldate-0.8.1-py3-none-any.whl (31.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size htmldate-0.8.1.tar.gz (1.2 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page