Final cleanups on modernization of build process.

Author: Alir3z4

README.md

@@ -62,21 +62,41 @@ Hello, [world](https://www.google.com/earth/)!
 `html2text` is available on pypi
 https://pypi.org/project/html2text/
 
-```
+```shell
 $ pip install html2text
 ```
 
+##  Development
 
-## How to run unit tests
+### How to run unit tests
 
-    tox
+```shell
+$ tox
+```
 
 To see the coverage results:
 
-    coverage html
+```shell
+$ coverage html
+```
 
 then open the `./htmlcov/index.html` file in your browser.
 
+
+### Code Quality & Pre Commit
+
+The CI runs several linting steps, including:
+
+- mypy
+- Flake8
+- Black
+
+To make sure the code passes the CI linting steps, run:
+
+```shell
+$ tox -e pre-commit
+```
+
 ## Documentation
 
 Documentation lives [here](https://github.com/Alir3z4/html2text/blob/master/docs/usage.md)

html2text/__init__.py

@@ -9,8 +9,8 @@
 from typing import Dict, List, Optional, Tuple, Union
 
 from . import config
-from ._version import __version_tuple__ as __version__
 from ._typing import OutCallback
+from ._version import __version_tuple__
 from .elements import AnchorElement, ListElement
 from .utils import (
     control_character_replacements,
@@ -29,6 +29,8 @@
     unifiable_n,
 )
 
+__version__ = __version_tuple__
+
 # TODO:
 # Support decoded entities with UNIFIABLE.
 

html2text/cli.py

@@ -1,7 +1,8 @@
 import argparse
 import sys
 
-from . import HTML2Text, __version__, config
+from . import HTML2Text, config
+from ._version import __version_tuple__ as __version__
 
 
 def main() -> None:

pyproject.toml

@@ -8,25 +8,24 @@ description = "Turn HTML into equivalent Markdown-structured text."
 readme = "README.md"
 authors = [{name = "Aaron Swartz", email = "me@aaronsw.com"}]
 maintainers = [{name = "Alireza Savand", email = "alireza.savand@gmail.com"}]
-license = {text = "GNU GPL 3"}
+license = "GPL-3.0-or-later"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU General Public License (GPL)",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.5",
-    "Programming Language :: Python :: 3.6",
-    "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
 urls = {Homepage = "https://github.com/Alir3z4/html2text/"}
-requires-python = ">=3.5"
+requires-python = ">=3.9"
 dynamic = ["version"]
 
 [project.scripts]
@@ -44,13 +43,23 @@ html2text = ["py.typed"]
 [tool.setuptools_scm]
 write_to = "html2text/_version.py"
 
+[tool.black]
+line-length = 88
+target-version = ['py313']
+extend-exclude = '''
+/(
+  html2text/_version.py
+)
+'''
+
 [tool.flake8]  # you will need Flake8-pyproject
 max_line_length = "88"
 extend-ignore = "E203"
 
 [tool.isort]
 profile = "black"
 combine_as_imports = true
+extend_skip = ["html2text/_version.py"]
 
 [tool.mypy]
-python_version = "3.5"
+python_version = "3.9"

tox.ini

@@ -18,29 +18,37 @@ setenv =
 
 [testenv:black]
 basepython = python3
-commands =
-    black --target-version py38 --line-length 88 --check --diff .
-deps =
-    black
+commands = black --check --diff .
+deps = black
 skip_install = true
 
 [testenv:flake8]
 basepython = python3
-commands =
-    flake8 --max-line-length 88
+commands = flake8
 deps =
     flake8
+    Flake8-pyproject
 skip_install = true
 
 [testenv:isort]
 basepython = python3
-commands =
-    isort --check-only --diff .
-deps =
-    isort
+commands = isort --check-only --diff .
+deps = isort
 skip_install = true
 
 [testenv:mypy]
 commands = mypy --strict html2text
 deps = mypy
+
+[testenv:pre-commit]
+basepython = python3
+commands =
+    isort --atomic .
+    flake8
+    black .
+deps =
+    isort
+    flake8
+    Flake8-pyproject
+    black
 skip_install = true