- Switched from setup.cfg to pyproject.toml for configuration.

- Removed build_sphinx from setup.py and documented how to build.

Author: mauvilsa

.bumpversion.cfg

@@ -8,10 +8,6 @@ serialize =
 	{major}.{minor}.{patch}{release}
 	{major}.{minor}.{patch}
 
-[bumpversion:file:setup.cfg]
-search = version = {current_version}
-replace = version = {new_version}
-
 [bumpversion:file:jsonargparse/__init__.py]
 
 [bumpversion:file:.sonarcloud.properties]

.circleci/config.yml

@@ -8,7 +8,9 @@ jobs:
       - checkout
       - run:
           name: Build wheel package
-          command: ./setup.py bdist_wheel sdist
+          command: |
+            pip3 install -U setuptools
+            ./setup.py bdist_wheel sdist
       - persist_to_workspace:
           root: .
           paths:
@@ -26,7 +28,7 @@ jobs:
             py=$(python3 --version | sed -r 's|.* 3\.([0-9]+)\..*|3.\1|')
             virtualenv -p python3 venv$py
             . venv$py/bin/activate
-            pip3 install $(ls ./dist/*.whl)[test_no_urls]
+            pip3 install $(ls ./dist/*.whl)[test-no-urls]
             python3 -m jsonargparse_tests coverage xml coverage_py$py.xml
             pip3 install $(ls ./dist/*.whl)[test,all]
             python3 -m jsonargparse_tests coverage xml coverage_py${py}_all.xml

.github/workflows/code-checks.yml

@@ -14,7 +14,7 @@ jobs:
         with:
           python-version: 3.8
           cache: pip
-          cache-dependency-path: "**/setup.cfg"
+          cache-dependency-path: "**/pyproject.toml"
       - run: pip install -e .[test,mypy]
       - run: mypy jsonargparse*/*.py
   pylint:
@@ -25,6 +25,6 @@ jobs:
         with:
           python-version: 3.8
           cache: pip
-          cache-dependency-path: "**/setup.cfg"
+          cache-dependency-path: "**/pyproject.toml"
       - run: pip install -e .[all,test,pylint]
-      - run: pylint --rcfile=setup.cfg jsonargparse*/*.py
+      - run: pylint jsonargparse*/*.py

.pre-commit-config.yaml

@@ -93,14 +93,14 @@ repos:
 
   - id: pycodestyle
     name: pycodestyle
-    entry: pycodestyle
+    entry: pycodestyle --exclude=sphinx/conf.py,setup.py --ignore=E241,E265,E128,E266,E226,E722,E252,E231,W291,E303,E221,E402,E306,E704,E251,E301,W504,E302 --max-line-length=180
     language: system
     types: [python]
     verbose: true
 
   - id: pylint
-    name: pylint --rcfile=setup.cfg
-    entry: pylint --rcfile=setup.cfg
+    name: pylint
+    entry: pylint
     language: system
     types: [python]
     verbose: true

CHANGELOG.rst

@@ -12,6 +12,15 @@ The semantic versioning only considers the public API as described in
 paths are considered internals and can change in minor and patch releases.
 
 
+v4.21.0 (2023-04-??)
+--------------------
+
+Changed
+^^^^^^^
+- Switched from ``setup.cfg`` to ``pyproject.toml`` for configuration.
+- Removed ``build_sphinx`` from ``setup.py`` and documented how to build.
+
+
 v4.20.1 (2023-03-30)
 --------------------
 

CONTRIBUTING.rst

@@ -7,15 +7,13 @@ proposing enhancements, or more directly by creating `pull requests
 <https://github.com/omni-us/jsonargparse/pulls>`_.
 
 If you intend to work with the source code, note that this project does not
-include any :code:`requirements.txt` file. This is by intention. To make it very
+include any ``requirements.txt`` file. This is by intention. To make it very
 clear what are the requirements for different use cases, all the requirements of
-the project are stored in the file :code:`setup.cfg`. The basic runtime
-requirements are defined in section :code:`[options]` in the
-:code:`install_requires` entry. All extras requires for optional features listed
-in :ref:`installation` are stored in section :code:`[options.extras_require]`.
-Also there are :code:`test`, :code:`test_no_urls`, :code:`dev` and :code:`doc`
-entries in the same :code:`[options.extras_require]` section which lists
-requirements for testing, development and documentation building.
+the project are stored in the file ``pyproject.toml``. The basic runtime
+requirements are defined in ``dependencies``. Requirements for optional features
+stored in ``[project.optional-dependencies]``. Also in the same section there
+are requirements for testing, development and documentation building: ``test``,
+``test-no-urls``, ``dev`` and ``doc``.
 
 The recommended way to work with the source code is the following. First clone
 the repository, then create a virtual environment, activate it and finally
@@ -42,9 +40,17 @@ is done as follows:
 
     pre-commit install
 
+To build the documentation run:
+
+.. code-block:: bash
+
+    sphinx-build sphinx sphinx/_build sphinx/index.rst
+
+Then to see it, open the file ``sphinx/_build/index.html`` in a browser.
+
 Running the unit tests can be done either using using `tox
-<https://tox.readthedocs.io/en/stable/>`__ or the :code:`setup.py` script. The
-unit tests are also installed with the package, thus can be run in a production
+<https://tox.readthedocs.io/en/stable/>`__ or the ``setup.py`` script. The unit
+tests are also installed with the package, thus can be run in a production
 system.
 
 .. code-block:: bash

README.rst

@@ -209,8 +209,8 @@ via :ref:`sub-commands` similar to the single class example above, i.e.
 function to execute. If multiple classes or a mixture of functions and classes
 is given to :func:`.CLI`, to execute a method of a class, two levels of
 :ref:`sub-commands` are required. The first sub-command would be the name of the
-class and the second the name of the method, i.e. :code:`example.py class
-[init_arguments] method [arguments]`.
+class and the second the name of the method, i.e. ``example.py class
+[init_arguments] method [arguments]``.
 
 .. note::
 
@@ -673,8 +673,8 @@ Furthermore unexperienced users might mistakenly use ``type=bool`` which would
 not provide the intended behavior.
 
 With jsonargparse adding an argument with ``type=bool`` the intended action is
-implemented. If given as values ``{'yes', 'true'}`` or :code:`{'no', 'false'}`
-the corresponding parsed values would be ``True`` or ``False``. For example:
+implemented. If given as values ``{'yes', 'true'}`` or ``{'no', 'false'}`` the
+corresponding parsed values would be ``True`` or ``False``. For example:
 
 .. testsetup:: boolean
 
@@ -704,8 +704,8 @@ straightforward. A couple of examples would be:
     parser.add_argument('--with-op2', action=ActionYesNo(yes_prefix='with-', no_prefix='without-'))
 
 If the :class:`.ActionYesNo` class is used in conjunction with ``nargs='?'`` the
-options can also be set by giving as value any of :code:`{'true', 'yes',
-'false', 'no'}`.
+options can also be set by giving as value any of ``{'true', 'yes', 'false',
+'no'}``.
 
 
 .. _enums:
@@ -978,8 +978,7 @@ is how complex numbers are registered: ``register_type(complex)``. For other
 type classes that don't have these properties, to register it might be necessary
 to provide a serializer and/or deserializer function. Including the serializer
 and deserializer functions, the registration of the complex numbers example is
-equivalent to :code:`register_type(complex, serializer=str,
-deserializer=complex)`.
+equivalent to ``register_type(complex, serializer=str, deserializer=complex)``.
 
 A more useful example could be registering the ``datetime`` class. This case
 requires to give both a serializer and a deserializer as seen below.
@@ -1071,12 +1070,11 @@ the expected structure in the config files.
 The :py:attr:`.ArgumentParser.default_config_files` property can be set when
 creating a parser to specify patterns to search for configuration files. For
 example if a parser is created as
-:code:`ArgumentParser(default_config_files=['~/.myapp.yaml',
-'/etc/myapp.yaml'])`, when parsing if any of those two config files exist it
-will be parsed and used to override the defaults. All matched config files are
-parsed and applied in the given order. The default config files are always
-parsed first, this means that any command line argument will override its
-values.
+``ArgumentParser(default_config_files=['~/.myapp.yaml', '/etc/myapp.yaml'])``,
+when parsing if any of those two config files exist it will be parsed and used
+to override the defaults. All matched config files are parsed and applied in the
+given order. The default config files are always parsed first, this means that
+any command line argument will override its values.
 
 It is also possible to add an argument to explicitly provide a configuration
 file path. Providing a config file as an argument does not disable the parsing
@@ -2367,7 +2365,7 @@ disabled. To enable, the ``logger`` argument should be set when creating an
 existing logger object which is used for the whole application. For convenience,
 to enable a default logger the ``logger`` argument can also receive ``True`` or
 a string which sets the name of the logger or a dictionary that can include the
-name and the level, e.g. :code:`{"name": "myapp", "level": "ERROR"}`. If
+name and the level, e.g. ``{"name": "myapp", "level": "ERROR"}``. If
 `reconplogger <https://pypi.org/project/reconplogger/>`__ is installed, setting
 ``logger`` to ``True`` or a dictionary without specifying a name, then the
 reconplogger is used. If reconplogger is installed and the

pyproject.toml

@@ -0,0 +1,181 @@
+[build-system]
+requires = ["setuptools>=65.6.3", "wheel>=0.38.4"]
+
+[project]
+name = "jsonargparse"
+dynamic = ["version", "readme"]
+description = "Implement minimal boilerplate CLIs derived from type hints and parse from command line, config files and environment variables."
+authors = [
+    {name = "Mauricio Villegas", email = "mauricio@omnius.com"},
+]
+license = {file = "LICENSE.rst"}
+requires-python = ">=3.6"
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "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",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+]
+
+dependencies = [
+    "PyYAML>=3.13",
+    "contextvars>=2.4; python_version == '3.6'",
+    "dataclasses>=0.8; python_version == '3.6'",
+]
+
+[project.optional-dependencies]
+all = [
+    "jsonargparse[signatures]",
+    "jsonargparse[jsonschema]",
+    "jsonargparse[jsonnet]",
+    "jsonargparse[urls]",
+    "jsonargparse[fsspec]",
+    "jsonargparse[argcomplete]",
+    "jsonargparse[ruyaml]",
+    "jsonargparse[omegaconf]",
+    "jsonargparse[typing-extensions]",
+    "jsonargparse[reconplogger]",
+]
+signatures = [
+    "docstring-parser>=0.15",
+    "typeshed-client>=2.1.0",
+]
+jsonschema = [
+    "jsonschema>=3.2.0",
+]
+jsonnet = [
+    "jsonnet>=0.13.0; os_name == 'posix'",
+    "jsonnet-binary>=0.17.0; os_name != 'posix'",
+]
+urls = [
+    "requests>=2.18.4",
+]
+fsspec = [
+    "fsspec>=0.8.4",
+]
+argcomplete = [
+    "argcomplete>=2.0.0",
+]
+ruyaml = [
+    "ruyaml>=0.20.0",
+]
+omegaconf = [
+    "omegaconf>=2.1.1",
+]
+typing-extensions = [
+    "typing-extensions>=3.10.0.0; python_version < '3.8'",
+]
+reconplogger = [
+    "reconplogger>=4.4.0",
+]
+test = [
+    "jsonargparse[test-no-urls]",
+    "jsonargparse[types-pyyaml]",
+    "responses>=0.12.0",
+    "types-requests>=2.28.9",
+]
+test-no-urls = [
+    "coverage>=4.5.1",
+]
+dev = [
+    "jsonargparse[test]",
+    "jsonargparse[doc]",
+    "jsonargparse[pylint]",
+    "jsonargparse[mypy]",
+    "pre-commit>=2.19.0",
+    "tox>=3.25.0",
+    "pycodestyle>=2.5.0",
+]
+pylint = [
+    "pylint>=2.15.6",
+]
+mypy = [
+    "jsonargparse[types-pyyaml]",
+    "mypy>=0.701",
+]
+types-pyyaml = [
+    "types-PyYAML>=6.0.11",
+]
+doc = [
+    "Sphinx>=1.7.9",
+    "sphinx-rtd-theme>=0.4.3",
+    "autodocsumm>=0.1.10",
+    "sphinx-autodoc-typehints>=1.19.5",
+]
+maintainer = [
+    "bump2version>=0.5.11",
+]
+
+[project.urls]
+Documentation-stable = "https://jsonargparse.readthedocs.io/en/stable/"
+Documentation-latest = "https://jsonargparse.readthedocs.io/en/latest/"
+Changes = "https://jsonargparse.readthedocs.io/en/stable/changelog.html"
+GitHub = "https://github.com/omni-us/jsonargparse"
+PyPI = "https://pypi.org/project/jsonargparse"
+CircleCI = "https://circleci.com/gh/omni-us/jsonargparse"
+SonarCloud = "https://sonarcloud.io/dashboard?id=omni-us_jsonargparse"
+Codecov = "https://codecov.io/gh/omni-us/jsonargparse"
+
+[tool.setuptools]
+platforms = ["Any"]
+packages = ["jsonargparse", "jsonargparse_tests"]
+
+
+[tool.setuptools.dynamic]
+version = {attr = "jsonargparse.__version__"}
+
+
+[tool.setuptools.package-data]
+jsonargparse = [
+    "*.pyi",
+    "py.typed",
+]
+
+
+[tool.mypy]
+ignore_missing_imports = true
+allow_redefinition = true
+warn_unused_ignores = true
+
+
+[tool.pylint]
+disable = "no-member"
+errors-only = true
+
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py{37,38,39,310,311}-{all,no}-extras,pypy3,omegaconf
+skip_missing_interpreters = true
+
+[testenv]
+extras =
+    all-extras: test,all
+    no-extras: test-no-urls
+changedir = jsonargparse_tests
+commands = python -m unittest
+usedevelop = true
+
+[testenv:omegaconf]
+extras = test,all
+setenv =
+    JSONARGPARSE_OMEGACONF_FULL_TEST = true
+"""