Replacing requirement files and setup.py with pyproject.toml (qiskit-…

…community#70)

* first attempt to add pyproject.toml

* tested pyproject.toml

* remove unnecessary files

* add realease notes

* add release notes

* additional changes to pyproject.toml

* improve style in pyproject.toml

* removing release notes

* Update pyproject.toml

Co-authored-by: Jim Garrison <jim@garrison.cc>

* minimal setup.py

* adding single trailing new line in setup.py

* replace requirement files on tox.ini with extras = dev

* removing the dev and min version test workflows

* commenting out the paragraphs about dev and min version test workflows from README.md

* added pyproject.toml description to file-map-and-description.md

* Update tox.ini (#1)

* Update tox.ini

thank you! I understand.

Co-authored-by: Jim Garrison <jim@garrison.cc>

* Update README.md (#2)

* Update docs/file-map-and-description.md

Co-authored-by: Jim Garrison <jim@garrison.cc>

* Fixing comment sections (#3)

* Update README.md

adding comment section that was removed by mistake

* Update README.md

re-adding comment section

* Update file-map-and-description.md

removing comments referring to `requirments.txt`

* Update docs/file-map-and-description.md

Co-authored-by: Jim Garrison <jim@garrison.cc>

---------

Co-authored-by: Jim Garrison <jim@garrison.cc>

.github/workflows/README.md

@@ -10,15 +10,15 @@ This workflow checks that the code is formatted properly and follows the style g
 
 This workflow installs the latest version of tox and runs [the current repository's tests](/tests/#test-py-environments) under each supported Python version on Linux and under a single Python version on macOS and Windows.  This is the primary testing workflow.  It runs for all code changes and additionally once per day, to ensure tests continue to pass as new versions of dependencies are released.
 
-## Development version tests (`test_development_versions.yml`)
+<!-- ## Development version tests (`test_development_versions.yml`)
 
 This workflow installs tox and modifies `requirements.txt` to use the _development_ versions of all Qiskit packages.  For all other packages, the latest version is installed.  This workflow runs on two versions of Python: the minimum supported version and the maximum supported version.  Its purpose is to identify as soon as possible (i.e., before a Qiskit release) when changes in Qiskit will break the current repository.  This workflow runs for all code changes, as well as on a timer once per day.
 
 ## Minimum version tests (`test_minimum_versions.yml`)
 
 This workflow first installs the minimum supported tox version (the `minversion` specified in [`tox.ini`](/tox.ini)) and then installs the _minimum_ compatible version of each package listed in `requirements.txt` and `requirements-dev.txt`.  The purpose of this workflow is to make sure the minimum version specifiers in these files are accurate, i.e., that the tests actually pass with these versions.  This workflow uses a single Python version, typically the oldest supported version, as the minimum supported versions of each package may not be compatible with the most recent Python release.
 
-Under the hood, this workflow uses a regular expression to change each `>=` and `~=` specifier in the requirements files to instead be `==`, as pip [does not support](https://github.com/pypa/pip/issues/8085) resolving the minimum versions of packages directly.  Unfortunately, this means that the workflow will only install the minimum version of a package if it is _explicitly_ listed in one of the requirements files with a minimum version.  For instance, a requirements file that simply lists `qiskit>=0.34` will actually install `qiskit==0.34` (i.e., the minimum version of the _meta_-package) along with the latest versions of `qiskit-terra` and `qiskit-aer`, unless their minimum versions are specified explicitly as well.
+Under the hood, this workflow uses a regular expression to change each `>=` and `~=` specifier in the requirements files to instead be `==`, as pip [does not support](https://github.com/pypa/pip/issues/8085) resolving the minimum versions of packages directly.  Unfortunately, this means that the workflow will only install the minimum version of a package if it is _explicitly_ listed in one of the requirements files with a minimum version.  For instance, a requirements file that simply lists `qiskit>=0.34` will actually install `qiskit==0.34` (i.e., the minimum version of the _meta_-package) along with the latest versions of `qiskit-terra` and `qiskit-aer`, unless their minimum versions are specified explicitly as well. -->
 
 ## Code coverage (`coverage.yml`)
 

docs/file-map-and-description.md

@@ -24,11 +24,8 @@ File descriptions for template
   [Most popular open-source licenses](https://opensource.org/licenses).
 - [README.md](../README.md) - main readme for repository.
 - [docs](../docs) - documentation for repository.
-- [requirements.txt](../requirements.txt) - list of required 3rd party packages to run your project.
-- [requirements-dev.txt](../requirements-dev.txt) - list of required 3rd party packages that are
-  NOT required to run your project, but which might benefit developers. It can include specific test
-  libraries, style checks packages etc.
-- [setup.py](../setup.py) - file that tells package managers how to use your project.
+- [pyproject.toml](../pyproject.toml) - file that contains the build system requirements for your python project.
+- [setup.py](../setup.py) - exists for compatibility with legacy tools.
   This is the main configuration file for all Python projects.
 - [tests](../tests) - folder where all project tests are located.
   It is a good practice to cover your project with tests to ensure correctness of implementation.

pyproject.toml

@@ -0,0 +1,54 @@
+# file pyproject.toml
+
+[project]
+name = "prototype_template"
+dynamic = [
+    "version",
+]
+readme = "README.md"
+requires-python = ">=3.7"
+license = {file = "LICENSE.txt"}
+description = "Repository for a quantum prototype"
+authors = [
+   { name = "My Name", email = "my.email@email.net"},
+]
+
+dependencies = [
+    "certifi>=2021.5.30",
+    "importlib_metadata>=4.8.1",
+    "qiskit-aer>=0.10.3",
+    "qiskit-terra>=0.19.2",
+]
+
+[project.optional-dependencies]
+# Dev dependencies.
+dev = [
+    "coverage>=5.5",
+    "pylint>=2.9.5",
+    "nbqa>=1.1.1",
+    "treon>=0.1.3",
+    "pytest>=6.2.5",
+    "pytest-randomly>=1.2.0",
+    "mypy>=0.780",
+    "mypy-extensions>=0.4.3",
+    "jupyter-sphinx>=0.3.2",
+    "nbsphinx>=0.8.8",
+    "sphinx-autodoc-typehints>=1.17.0",
+    "reno>=3.5.0",
+    # Black's formatting rules can change between major versions, so we use
+    # the ~= specifier for it.
+    "black[jupyter]~=22.1",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/qiskit-community/quantum-prototype-template"
+"Bug Tracker" = "https://github.com/qiskit-community/quantum-prototype-template/issues"
+
+[build-system]
+requires = [
+    "setuptools>=61.0",
+    "wheel",
+    "toml",
+    "setuptools-scm",
+]
+build-backend = "setuptools.build_meta"

setup.py

@@ -1,21 +1,7 @@
-"""Setup file for prototype template."""
+# See pyproject.toml for project configuration.
+# This file exists for compatibility with legacy tools:
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
 
-import setuptools
+from setuptools import setup
 
-with open("README.md", encoding="utf-8") as f:
-    long_description = f.read()
-
-with open("requirements.txt") as f:
-    install_requires = f.read().splitlines()
-
-setuptools.setup(
-    name="prototype_template",
-    description="Repository for a quantum prototype",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    packages=setuptools.find_packages(),
-    install_requires=install_requires,
-    python_requires=">=3.7",
-    setup_requires=["setuptools_scm"],
-    use_scm_version=True,
-)
+setup()

tox.ini

@@ -12,16 +12,15 @@ setenv =
   VIRTUAL_ENV={envdir}
   LANGUAGE=en_US
   LC_ALL=en_US.utf-8
-deps = -rrequirements.txt
-       -rrequirements-dev.txt
+extras = dev
 commands =
   pip check
   python -m pytest -v --doctest-modules
   treon docs --threads 2
 
 [testenv:lint]
 envdir = .tox/lint
-skip_install = true
+extras = dev
 commands =
   black --check .
   pylint -rn prototype_template tests
@@ -44,8 +43,7 @@ commands =
 
 [testenv:docs]
 skip_install = false
-deps =
-    -rrequirements-dev.txt
+extras = dev
 commands =
   sphinx-build -b html -W -T --keep-going {posargs} docs/ docs/_build/html