Move project metadata to pyproject.toml, clean-up

setup.cfg → .flake8

@@ -1,12 +1,6 @@
-[metadata]
-license_file = LICENSE
-
 [flake8]
 max-line-length = 100
 exclude = compoundsuper.py,indexsuper.py
 extend-ignore = E203, E231
 per-file-ignores =
     breathe/parser/index.py:E305
-
-[bdist_wheel]
-universal = 0

.github/workflows/documentation.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
@@ -19,9 +19,9 @@ jobs:
 
       - name: install dependencies
         run: |
-          pip install -r requirements/development.txt
           sudo apt-get -y update
           sudo apt-get -y install graphviz libclang1-11 libclang-cpp11
+          pip install -e .[dev]
 
       - name: install doxygen from SF binary archives
         env:

.github/workflows/lint.yml

@@ -10,15 +10,15 @@ jobs:
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: set up python
         uses: actions/setup-python@v1
 
       - name: install dependencies
         run: |
-          pip install -r requirements/development.txt
+          pip install -e .[lint]
 
       - name: lint the source code
         run: make flake8
@@ -28,6 +28,3 @@ jobs:
 
       - name: type check the source code
         run: make type-check
-
-      - name: check version numbers are in sync
-        run: make version-check

.github/workflows/unit_tests.yml

@@ -36,7 +36,7 @@ jobs:
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: set up python ${{ matrix.python-version }}
@@ -54,7 +54,7 @@ jobs:
 
       - name: install dependencies
         run: |
-          pip install -r requirements/development.txt
+          pip install -e .[dev]
 
       - name: run the unit tests
         run: make dev-test

Makefile

@@ -45,7 +45,3 @@ black:
 .PHONY: type-check
 type-check:
 	mypy --warn-redundant-casts --warn-unused-ignores breathe tests
-
-.PHONY: version-check
-version-check:
-	 PYTHONPATH=../:$(PYTHONPATH) python3 scripts/version-check.py

breathe-apidoc.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 import sys
 

breathe/__init__.py

@@ -4,7 +4,7 @@
 
 from sphinx.application import Sphinx
 
-# Keep in sync with setup.py __version__
+# Keep version here
 __version__ = "4.34.0"
 
 

breathe/apidoc.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
     breathe.apidoc
     ~~~~~~~~~~~~~~

documentation/environment.yaml

@@ -11,4 +11,4 @@ dependencies:
   - doxygen
   - pip
   - pip:
-    - -r ../requirements/development.txt
+    - ..[dev]

documentation/source/conf.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # BreatheExample documentation build configuration file, created by
 # sphinx-quickstart on Tue Feb  3 18:20:48 2009.
 #
@@ -123,9 +121,9 @@
     release = "compare"
 
 # Only add spelling extension if it is available. We don't know if it is installed as we don't want
-# to put it in the setup.py file as a dependency as we don't want Breathe to be dependent on it as
-# people should be able to use Breathe without 'spelling'. There might be a better way to handle
-# this.
+# to put it in the pyproject.toml file as a dependency as we don't want Breathe to be dependent on
+# it as people should be able to use Breathe without 'spelling'. There might be a better way to
+# handle this.
 try:
     import sphinxcontrib.spelling
 

mkrelease

@@ -40,7 +40,7 @@ pack()
 	tar -xf "breathe-$version.tar.gz"
 
 	cd -- "breathe-$version"
-	python3 setup.py sdist bdist_wheel
+	python3 -m build
 	mv -- dist ..
 
 	cd -- ..
@@ -66,6 +66,7 @@ upload()
 (
 	cd -- mkrelease_tmp
 
+	twine check --strict dist/*
 	twine upload -- dist/*
 
 	{

pyproject.toml

@@ -1,3 +1,76 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "breathe"
+dynamic = ["version"]
+authors = [
+    {name = "Michael Jones", email = "[email protected]"},
+]
+description = "Sphinx Doxygen renderer"
+license = {text = "BSD-3-Clause"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Documentation",
+    "Topic :: Text Processing",
+    "Topic :: Utilities",
+]
+requires-python = ">=3.7"
+dependencies = [
+    "docutils>=0.12",
+    "Jinja2>=2.7.3",
+    "MarkupSafe>=0.23",
+    "Pygments>=1.6",
+    "Sphinx>=4.0,<6,!=5.0.0",
+]
+
+[project.optional-dependencies]
+lint = [
+    "black==22.3.0",
+    "flake8",
+    "mypy>=0.900",
+]
+test = [
+    "pytest",
+]
+dev = [
+    "breathe[lint,test]",
+    "furo",
+    "pip-tools>=0.3.5",
+    "types-docutils>=0.14,<0.18",
+    "types-Pygments",
+    "sphinx-copybutton",
+]
+
+[project.scripts]
+breathe-apidoc = "breathe.apidoc:main"
+
+[project.readme]
+text = """\
+Breathe is an extension to reStructuredText and Sphinx to be able to read and
+render `Doxygen <https://www.doxygen.nl>`__ xml output.
+"""
+content-type = "text/x-rst"
+
+[project.urls]
+Home = "https://www.breathe-doc.org/"
+Repository = "https://github.com/breathe-doc/breathe"
+
+[tool.setuptools.dynamic]
+version = {attr = "breathe.__init__.__version__"}
+
+[tool.setuptools.packages.find]
+include = ["breathe", "breathe.*"]
+
 [tool.black]
 line-length = 100
 extend-exclude = '''

setup.py

@@ -1,61 +1,4 @@
-# -*- coding: utf-8 -*-
-try:
-    from setuptools import setup, find_packages
-except ImportError:
-    import distribute_setup
+from setuptools import setup
 
-    distribute_setup.use_setuptools()
-    from setuptools import setup, find_packages
 
-import sys
-
-# Keep in sync with breathe/__init__.py __version__
-__version__ = "4.34.0"
-
-long_desc = """
-Breathe is an extension to reStructuredText and Sphinx to be able to read and
- render `Doxygen <http://www.doxygen.org>`__ xml output.
-"""
-
-requires = ["Sphinx>=4.0,<6,!=5.0.0", "docutils>=0.12"]
-
-if sys.version_info < (3, 7):
-    print("ERROR: Sphinx requires at least Python 3.7 to run.")
-    sys.exit(1)
-
-
-setup(
-    name="breathe",
-    version=__version__,
-    url="https://github.com/michaeljones/breathe",
-    download_url="https://github.com/michaeljones/breathe",
-    license="BSD",
-    author="Michael Jones",
-    author_email="[email protected]",
-    description="Sphinx Doxygen renderer",
-    long_description=long_desc,
-    zip_safe=False,
-    classifiers=[
-        "Development Status :: 4 - Beta",
-        "Environment :: Console",
-        "Environment :: Web Environment",
-        "Framework :: Sphinx :: Extension",
-        "Intended Audience :: Developers",
-        "Intended Audience :: Education",
-        "License :: OSI Approved :: BSD License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3",
-        "Topic :: Documentation",
-        "Topic :: Text Processing",
-        "Topic :: Utilities",
-    ],
-    platforms="any",
-    packages=find_packages(),
-    include_package_data=True,
-    entry_points={
-        "console_scripts": [
-            "breathe-apidoc = breathe.apidoc:main",
-        ],
-    },
-    install_requires=requires,
-)
+setup(name="breathe")

tests/warnings/source/conf.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # Test Breathe Warnings documentation build configuration file, created by
 # sphinx-quickstart on Thu Jun  5 18:57:21 2014.
 #