Apply pyproject.toml standard (#167)

* Apply pyproject.toml standard

* Update setup.py/README.rst to match pyproject.toml/README.md

* Open controls documentation link

* Update setup.py/README.rst to match pyproject.toml/README.md

* Add repository

* Update setup.py/README.rst to match pyproject.toml/README.md

Co-authored-by: Q-CTRL DevOps <[email protected]>

Author: cfarrend

DESCRIPTION.md

@@ -0,0 +1,13 @@
+# Q-CTRL Open Controls
+
+Q-CTRL Open Controls is an open-source Python package that makes it easy to
+create and deploy established error-robust quantum control protocols from the
+open literature. The aim of the package is to be the most comprehensive library
+of published and tested quantum control techniques developed by the community,
+with easy to use export functions allowing users to deploy these controls on:
+
+- Custom quantum hardware
+- Publicly available cloud quantum computers
+- The [Q-CTRL product suite](https://q-ctrl.com/products/)
+
+Anyone interested in quantum control is welcome to contribute to this project.

README.md

@@ -1,7 +1,4 @@
-# Q-CTRL Open Controls Python package
-
-[![Actions Status](https://github.com/qctrl/python-open-controls/workflows/Push%20workflow/badge.svg)](https://github.com/qctrl/python-open-controls/actions?query=workflow%3A"Push+workflow")
-[![Actions Status](https://github.com/qctrl/python-open-controls/workflows/Release%20workflow/badge.svg)](https://github.com/qctrl/python-open-controls/actions?query=workflow%3A"Release+workflow")
+# Q-CTRL Open Controls
 
 Q-CTRL Open Controls is an open-source Python package that makes it easy to
 create and deploy established error-robust quantum control protocols from the

README.rst

@@ -4,29 +4,33 @@ version = "7.0.0"
 description = "Q-CTRL Open Controls"
 license = "Apache-2.0"
 authors = ["Q-CTRL <[email protected]>"]
-readme = "README.md"
+maintainers = ["Q-CTRL <[email protected]>"]
+readme = "DESCRIPTION.md"
+homepage = "https://q-ctrl.com"
+repository = "https://github.com/qctrl/python-open-controls"
+documentation = "https://docs.q-ctrl.com/references/python/qctrl-open-controls/"
 keywords = [
-    "quantum", 
-    "computing", 
-    "open source", 
-    "engineering"
+    "q-ctrl",
+    "qctrl",
+    "quantum control"
 ]
 classifiers = [
-            "Development Status :: 5 - Production/Stable",
-            "Environment :: Console",
-            "Intended Audience :: Developers",
-            "Intended Audience :: Education",
-            "Intended Audience :: Science/Research",
-            "License :: OSI Approved :: Apache Software License",
-            "Natural Language :: English",
-            "Operating System :: OS Independent",
-            "Programming Language :: Python :: 3.6",
-            "Topic :: Scientific/Engineering :: Physics",
-            "Topic :: Scientific/Engineering :: Visualization",
-            "Topic :: Software Development :: Embedded Systems",
-            "Topic :: System :: Distributed Computing"
-        ]
-repository = "https://github.com/qctrl/python-open-controls"
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Distributed Computing"
+]
 packages = [
     { include = "qctrlopencontrols" },
 ]
@@ -50,6 +54,10 @@ nbval = "^0.9.5"
 qctrl-visualizer = "^2.3.0"
 isort = "^5.4.2"
 
+[tool.poetry.urls]
+GitHub = "https://github.com/qctrl"
+Twitter = "https://twitter.com/qctrlHQ"
+
 [tool.black]
 exclude = '''
 (

pyproject.toml

@@ -15,7 +15,7 @@
 
 readme = ''
 here = os.path.abspath(os.path.dirname(__file__))
-readme_path = os.path.join(here, 'README.rst')
+readme_path = os.path.join(here, 'DESCRIPTION.rst')
 if os.path.exists(readme_path):
     with open(readme_path, 'rb') as stream:
         readme = stream.read().decode('utf8')
@@ -27,12 +27,12 @@
     version='7.0.0',
     description='Q-CTRL Open Controls',
     python_requires='<3.9,>=3.6.4',
-    project_urls={"repository": "https://github.com/qctrl/python-open-controls"},
+    project_urls={"documentation": "https://docs.q-ctrl.com/references/python/qctrl-open-controls/", "homepage": "https://q-ctrl.com", "repository": "https://github.com/qctrl/python-open-controls"},
     author='Q-CTRL',
     author_email='[email protected]',
     license='Apache-2.0',
-    keywords='quantum computing open source engineering',
-    classifiers=['Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: Education', 'Intended Audience :: Science/Research', 'License :: OSI Approved :: Apache Software License', 'Natural Language :: English', 'Operating System :: OS Independent', 'Programming Language :: Python :: 3.6', 'Topic :: Scientific/Engineering :: Physics', 'Topic :: Scientific/Engineering :: Visualization', 'Topic :: Software Development :: Embedded Systems', 'Topic :: System :: Distributed Computing'],
+    keywords='q-ctrl qctrl quantum control',
+    classifiers=['Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: Education', 'Intended Audience :: Science/Research', 'Natural Language :: English', 'Operating System :: OS Independent', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Topic :: Internet :: WWW/HTTP', 'Topic :: Scientific/Engineering :: Physics', 'Topic :: Scientific/Engineering :: Visualization', 'Topic :: Software Development :: Embedded Systems', 'Topic :: System :: Distributed Computing'],
     packages=['qctrlopencontrols', 'qctrlopencontrols.driven_controls', 'qctrlopencontrols.dynamic_decoupling_sequences'],
     package_dir={"": "."},
     package_data={},