prepare v1.9.0 and update docs (#161)

adbar · web-flow · commit ec51dc19eae1 · 2024-08-27T12:08:21.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 ## Changelog
 
 
+## 1.9.0
+- focus on Python 3.8+, use pyproject.toml file and update setup (#150, #153, #160)
+- revamp tests and evaluation (#151)
+- simplify code parts (#152)
+- docs: convert readme to markdown (#147)
+
 ## 1.8.1
 - fix: more restrictive YYYYMM pattern to prevent ValueError with @b3n4kh (#145)
 - maintenance: add pre-commit with checks with @nadasuhailAyesh12 (#142)
diff --git a/README.md b/README.md
@@ -93,12 +93,14 @@ page](https://htmldate.readthedocs.io/en/latest/evaluation.html).
 ## Installation
 
 Htmldate is tested on Linux, macOS and Windows systems, it is compatible
-with Python 3.6 upwards. It can notably be installed with `pip` (`pip3`
+with Python 3.8 upwards. It can notably be installed with `pip` (`pip3`
 where applicable) from the PyPI package repository:
 
 -   `pip install htmldate`
 -   (optionally) `pip install htmldate[speed]`
 
+The last version to support Python 3.6 and 3.7 is `htmldate==1.8.1`.
+
 ## Documentation
 
 For more details on installation, Python & CLI usage, **please refer to
diff --git a/docs/corefunctions.rst b/docs/corefunctions.rst
@@ -26,17 +26,15 @@ Useful internal functions
 
 .. autofunction:: htmldate.extractors.extract_url_date
 
-.. autofunction:: htmldate.extractors.extract_partial_url_date
-
 .. autofunction:: htmldate.extractors.external_date_parser
 
 
 Helpers
 -------
 
-.. autofunction:: htmldate.extractors.convert_date
+.. autofunction:: htmldate.validators.is_valid_date
 
-.. autofunction:: htmldate.extractors.date_validator
+.. autofunction:: htmldate.validators.convert_date
 
 .. autofunction:: htmldate.utils.load_html
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -96,7 +96,7 @@ Installation
 Main package
 ~~~~~~~~~~~~
 
-This Python package is tested on Linux, macOS and Windows systems; it is compatible with Python 3.6 upwards. It is available on the package repository `PyPI <https://pypi.org/>`_ and can notably be installed with ``pip`` or ``pipenv``:
+This Python package is tested on Linux, macOS and Windows systems; it is compatible with Python 3.8 upwards. It is available on the package repository `PyPI <https://pypi.org/>`_ and can notably be installed with ``pip`` or ``pipenv``:
 
 .. code-block:: bash
 
@@ -105,6 +105,9 @@ This Python package is tested on Linux, macOS and Windows systems; it is compati
     $ pip install git+https://github.com/adbar/htmldate.git # latest available code (see build status above)
 
 
+The last version to support Python 3.6 and 3.7 is ``htmldate==1.8.1``.
+
+
 Optional
 ~~~~~~~~
 
diff --git a/docs/options.rst b/docs/options.rst
@@ -51,7 +51,7 @@ Change the output to a format known to Python's ``datetime`` module, the default
     '2016-12-23T05:11:00-0500'
 
 
-.. autofunction:: htmldate.validators.output_format_validator
+.. autofunction:: htmldate.validators.is_valid_format
 
 
 Original date
@@ -89,8 +89,6 @@ Clearing caches
     # at a given point in time
     >>> reset_caches()
 
-*New in version 1.3.0.*
-
 
 Tests
 -----
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
 # version required
-sphinx>=7.2.6
+sphinx>=8.0.2
 # without version specifier
 htmldate
diff --git a/docs/used-by.rst b/docs/used-by.rst
@@ -64,10 +64,12 @@ Citations in papers
 Publications citing Htmldate
 ----------------------------
 
+- Ariyarathne, G., & Nwala, A. C. (2024). 3DLNews: A Three-decade Dataset of US Local News Articles. arXiv preprint arXiv:2408.04716.
 - Grabovoy, A., Bakhteev, O., & Chekhovich, Y. (2021). "The automatic approach for scientific papers dating," 2021 Ivannikov Ispras Open Conference (ISPRAS), pp. 107-113, IEEE, DOI: 10.1109/ISPRAS53967.2021.00020.
-Hanley, H. W., Kumar, D., & Durumeric, Z. (2023). Happenstance: Utilizing Semantic Search to Track Russian State Media Narratives about the Russo-Ukrainian War On Reddit. In Proceedings of the international AAAI conference on web and social media (Vol. 17, pp. 327-338).
-- Hanley, H. W., Kumar, D., & Durumeric, Z. (2023). A Golden Age: Conspiracy Theories' Relationship with Misinformation Outlets, News Media, and the Wider Internet. arXiv preprint arXiv:2301.10880.
+- Hanley, H. W., Kumar, D., & Durumeric, Z. (2023). Happenstance: Utilizing Semantic Search to Track Russian State Media Narratives about the Russo-Ukrainian War On Reddit. In Proceedings of the international AAAI conference on web and social media (Vol. 17, pp. 327-338).
+- Hanley, H. W., Kumar, D., & Durumeric, Z. (2023). A Golden Age: Conspiracy Theories' Relationship with Misinformation Outlets, News Media, and the Wider Internet. Proceedings of the ACM on Human-Computer Interaction, 7(CSCW2), 1-33.
 - Kupi, M. (2021). "Late to the Party? Agile Methods in British and German Government Institutions", Master’s thesis, Hertie School Berlin.
+- Olier, J. S., & Spadavecchia, C. (2024). Migration and emotions in the media: can socioeconomic indicators predict emotions in images associated with immigrants?. Journal of Computational Social Science, 1-32.
 - Smits, T., & Ros, R. (2021). "Distant reading 940,000 online circulations of 26 iconic photographs", New Media & Society, DOI: 10.1177/14614448211049.
 - Smits, T., & Ros, R. (2023). Space and Place in Online Visual Memory: The Tank Man in Hong Kong. The Visual Memory of Protest, Amsterdam University Press.
 - Stefanovitch, N. (2022). Team TMA at SemEval-2022 Task 8: Lightweight and Language-Agnostic News Similarity Classifier. In Proceedings of the 16th International Workshop on Semantic Evaluation (SemEval-2022) (pp. 1178-1183).
@@ -89,7 +91,6 @@ Software ecosystem
 
 
 .. image:: software-ecosystem.png
-    :alt: Software ecosystem 
+    :alt: Software ecosystem
     :align: center
     :width: 65%
-
diff --git a/htmldate/__init__.py b/htmldate/__init__.py
@@ -7,7 +7,7 @@
 __author__ = "Adrien Barbaresi"
 __license__ = "Apache-2.0"
 __copyright__ = "Copyright 2017-2024, Adrien Barbaresi"
-__version__ = "1.8.1"
+__version__ = "1.9.0"
 
 
 import logging
