Use modern pyproject based packaging

Author: AA-Turner

pyproject.toml

@@ -1,74 +1,60 @@
-# -*- coding: utf-8 -*-
-import os
-from setuptools import setup, find_packages
-
-long_desc = '''
-sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files.
-'''
-
-extras_require = {
-    'test': [
-        'pytest',
-        'html5lib',
-    ],
-    'lint': [
-        'flake8',
-        'mypy',
-        'types-setuptools',
-        'docutils-stubs',
-    ]
-}
-
-
-def get_version():
-    """Get version number of the package from version.py without importing core module."""
-    package_dir = os.path.abspath(os.path.dirname(__file__))
-    version_file = os.path.join(package_dir, 'sphinxcontrib/htmlhelp/version.py')
-
-    namespace = {}
-    with open(version_file, 'rt') as f:
-        exec(f.read(), namespace)
-
-    return namespace['__version__']
-
-
-setup(
-    name='sphinxcontrib-htmlhelp',
-    version=get_version(),
-    url='http://sphinx-doc.org/',
-    download_url='https://pypi.org/project/sphinxcontrib-htmlhelp/',
-    license='BSD',
-    author='Georg Brandl',
-    author_email='georg@python.org',
-    description="sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files",
-    long_description=long_desc,
-    long_description_content_type='text/x-rst',
-    zip_safe=False,
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Environment :: Console',
-        'Environment :: Web Environment',
-        'Intended Audience :: Developers',
-        'Intended Audience :: Education',
-        'License :: OSI Approved :: BSD License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Framework :: Sphinx',
-        'Framework :: Sphinx :: Extension',
-        'Topic :: Documentation',
-        'Topic :: Documentation :: Sphinx',
-        'Topic :: Text Processing',
-        'Topic :: Utilities',
-    ],
-    platforms='any',
-    python_requires=">=3.6",
-    packages=find_packages(exclude=['tests']),
-    include_package_data=True,
-    extras_require=extras_require,
-    namespace_packages=['sphinxcontrib'],
-)
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+# project metadata
+[project]
+name = "sphinxcontrib-htmlhelp"
+description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files"
+readme = "README.rst"
+urls.Changelog = "https://www.sphinx-doc.org/en/master/changes.html"
+urls.Code = "https://github.com/sphinx-doc/sphinxcontrib-htmlhelp"
+urls.Download = "https://pypi.org/project/sphinxcontrib-htmlhelp/"
+urls.Homepage = "https://www.sphinx-doc.org/"
+urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx/issues"
+license.text = "BSD-2-Clause"
+requires-python = ">=3.6"
+
+# Classifiers list: https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Framework :: Sphinx",
+    "Framework :: Sphinx :: Extension",
+    "Topic :: Documentation",
+    "Topic :: Documentation :: Sphinx",
+    "Topic :: Text Processing",
+    "Topic :: Utilities",
+]
+dependencies = []
+dynamic = ["version"]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "html5lib",
+]
+lint = [
+    "flake8",
+    "mypy",
+    "docutils-stubs",
+]
+
+[[project.authors]]
+name = "Georg Brandl"
+email = "georg@python.org"
+
+[tool.setuptools.dynamic]
+version.attr = "sphinxcontrib.htmlhelp.__version__"

setup.cfg

@@ -1,10 +1,3 @@
-[egg_info]
-tag_build = .dev
-tag_date = true
-
-[aliases]
-release = egg_info -Db ''
-
 [extract_messages]
 output_file = sphinxcontrib/htmlhelp/locales/sphinxcontrib.htmlhelp.pot
 keywords = _ __
@@ -14,12 +7,6 @@ domain = sphinxcontrib.htmlhelp
 directory = sphinxcontrib/htmlhelp/locales/
 use_fuzzy = true
 
-[bdist_wheel]
-universal = 1
-
-[metadata]
-license_file = LICENSE
-
 [flake8]
 max-line-length = 95
 ignore = E116,E241,E251

sphinxcontrib/__init__.py

@@ -30,8 +30,8 @@
 from sphinx.util.template import SphinxRenderer
 from sphinx.writers.html import HTMLTranslator
 
-from sphinxcontrib.htmlhelp.version import __version__
-
+__version__ = '2.0.1'
+__version_info__ = (2, 0, 1)
 
 logger = logging.getLogger(__name__)
 __ = get_translation(__name__, 'console')