Move metadata from setup.py to pyproject.toml and build retworkx in a separate setup.py (#1419)

* Modernize setup.py

* Farewell to retworkx

* Add release note about retworkx removal

* Move even more data to pyproject.toml

* PEP 639 says this is deprecated

* Add dependency groups later

* Move even from setup.py to pyproject.toml

* Migrate all setup.py to pyproject.toml

* Move nox dependencies to pyproject.toml

* Document new way to do debug builds now that we no longer use setup.py

* Better way to phrase the documentation

* Remove duplicate section

* Try updating setuptools for coverage job

* Add docs dependency group as well

* Make description the same as the paper

* Revert retworkx code

* Say this will be the last retworkx release

* Trying to make retworkx work

* retworkx has its own setup.py

* Account for new directory when publishing

* Document setuptools-rust

* Edit message saying it is the final release

* sunset -> retired

* Endline

* Ensure setuptools-rust is up-to-date

* Use setuptools>=70.1.0 and remove wheel

* Apply suggestions from code review

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

* Black

---------

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

Author: IvanIsCoding

.github/workflows/main.yml

@@ -37,9 +37,9 @@ jobs:
       - name: Clippy
         run: cargo clippy --workspace --all-targets -- -D warnings
       - name: Black Codestyle Format
-        run: black --check --diff retworkx rustworkx retworkx tests
+        run: black --check --diff rustworkx tests retworkx
       - name: Python Lint
-        run: ruff check rustworkx retworkx setup.py tests
+        run: ruff check rustworkx setup.py tests retworkx
       - name: Check stray release notes
         run: python tools/find_stray_release_notes.py
       - name: rustworkx-core Rust Tests
@@ -141,21 +141,21 @@ jobs:
       - name: Download grcov
         run: curl -L https://github.com/mozilla/grcov/releases/download/v0.8.7/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar jxf -
       - name: Install deps
-        run: pip install -U setuptools-rust networkx testtools fixtures stestr
-      - name: Build retworkx
+        run: pip install -U setuptools setuptools-rust networkx testtools fixtures stestr
+      - name: Build rustworkx
         run: python setup.py develop
         env:
           CARGO_INCREMENTAL: 0
           RUSTFLAGS: "-Cinstrument-coverage"
-          LLVM_PROFILE_FILE: "retworkx-%p-%m.profraw"
+          LLVM_PROFILE_FILE: "rustworkx-%p-%m.profraw"
       - name: Run tests
         run: cd tests && stestr run && cd ..
         env:
-          LLVM_PROFILE_FILE: "retworkx-%p-%m.profraw"
+          LLVM_PROFILE_FILE: "rustworkx-%p-%m.profraw"
       - name: Run grcov
         run: |
           set -e
-          mv tests/retworkx*profraw .
+          mv tests/rustworkx*profraw .
           ./grcov . --binary-path ./target/debug/ -s . -t lcov --branch --ignore-not-existing --ignore "/*" -o ./coveralls.lcov
       - uses: actions/upload-artifact@v4
         with:

.github/workflows/wheels.yml

@@ -202,12 +202,10 @@ jobs:
       - name: Install deps
         run: pip install -U setuptools-rust wheel build
       - name: Build sdist
-        run: python setup.py bdist_wheel
-        env:
-          RUSTWORKX_PKG_NAME: retworkx
+        run: pushd retworkx && python setup.py bdist_wheel && popd
       - uses: actions/upload-artifact@v4
         with:
-          path: ./dist/*
+          path: ./retworkx/dist/*
           name: sdist-retworkx
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -21,6 +21,7 @@ retworkx/*pyd
 !/docs/source/images/*.svg
 *.jpg
 **/*.so
-retworkx-core/Cargo.lock
+rustworkx-core/Cargo.lock
 **/.DS_Store
 venv/
+.python-version

README.md

@@ -59,7 +59,7 @@ environment.
 
 If there are no precompiled binaries published for your system you'll have to
 build the package from source. However, to be able to build the package
-from the published source package you need to have Rust >= 1.70 installed (and
+from the published source package you need to have Rust >= 1.79 installed (and
 also [cargo](https://doc.rust-lang.org/cargo/) which is normally included with
 rust) You can use [rustup](https://rustup.rs/) (a cross platform installer for
 rust) to make this simpler, or rely on
@@ -77,10 +77,10 @@ it just as it would if there was a prebuilt binary available.
 > [!NOTE]  
 > To build from source you will need to ensure you have pip >=19.0.0
 installed, which supports PEP-517, or that you have manually installed
-`setuptools-rust` prior to running `pip install rustworkx`. If you receive an
+`setuptools-rust>=1.9` prior to running `pip install rustworkx`. If you receive an
 error about `setuptools-rust` not being found you should upgrade pip with
 `pip install -U pip` or manually install `setuptools-rust` with
-`pip install setuptools-rust` and try again.
+`pip install -U setuptools-rust` and try again.
 
 ### Optional dependencies
 
@@ -157,17 +157,14 @@ changes reflected in your python environment.
 ### Develop Mode
 
 If you'd like to build rustworkx in debug mode and use an interactive debugger
-while working on a change you can use `python setup.py develop` to build
-and install rustworkx in develop mode. This will build rustworkx without
-optimizations and include debuginfo which can be handy for debugging. Do note
-that installing rustworkx this way will be significantly slower then using
-`pip install` and should only be used for debugging/development.
+while working on a change you can set `SETUPTOOLS_RUST_CARGO_PROFILE="dev"`
+as an environment variable to build and install rustworkx in develop mode.
+This will build rustworkx without optimizations and include debuginfo
+when running `pip install`. That can be handy for debugging.
 
 > [!TIP]
 > It's worth noting that `pip install -e` does not work, as it will link the python
-packaging shim to your python environment but not build the rustworkx binary. If
-you want to build rustworkx in debug mode you have to use
-`python setup.py develop`.
+packaging shim to your python environment but not build the rustworkx binary.
 
 ## Project history
 

docs/source/api/pydigraph_api_functions.rst

@@ -5,7 +5,7 @@ API functions for PyDigraph
 
 These functions are algorithm functions that are type specific for
 :class:`~rustworkx.PyDiGraph` or :class:`~rustworkx.PyDAG` objects. Universal
-functions from Retworkx API that work for both graph types internally call
+functions from Rustworkx API that work for both graph types internally call
 the functions from the explicitly typed based on the data type.
 
 .. autosummary::

noxfile.py

@@ -3,25 +3,12 @@
 nox.options.reuse_existing_virtualenvs = True
 nox.options.stop_on_first_error = True
 
-deps = [
-  "setuptools-rust",
-  "fixtures",
-  "testtools>=2.5.0",
-  "networkx>=2.5",
-  "stestr>=4.1",
-]
+pyproject = nox.project.load_toml("pyproject.toml")
 
-lint_deps = [
-    "black~=24.8",
-    "ruff~=0.6",
-    "setuptools-rust",
-    "typos~=1.28",
-]
-
-stubs_deps = [
-    "mypy==1.11.2",
-    "typing-extensions>=4.4",
-]
+deps = nox.project.dependency_groups(pyproject, "test")
+lint_deps = nox.project.dependency_groups(pyproject, "lint")
+stubs_deps = nox.project.dependency_groups(pyproject, "stubs")
+docs_deps = nox.project.dependency_groups(pyproject, "docs")
 
 def install_rustworkx(session):
     session.install(*deps)
@@ -55,7 +42,7 @@ def lint(session):
 @nox.session(python=["3"])
 def docs(session):
     install_rustworkx(session)
-    session.install("-r", "docs/source/requirements.txt", "-c", "constraints.txt")
+    session.install(*docs_deps, "-c", "constraints.txt")
     session.run("python", "-m", "ipykernel", "install", "--user")
     session.run("jupyter", "kernelspec", "list")
     session.chdir("docs")

pyproject.toml

@@ -1,14 +1,110 @@
+[project]
+name = "rustworkx"
+version = "0.17.0"
+description = "A High-Performance Graph Library for Python"
+requires-python = ">=3.9"
+dependencies = [
+    "numpy>=1.16.0,<3"
+]
+readme = {file = "README.md", content-type = "text/markdown"}
+license-files = ["LICENSE"]
+license = "Apache-2.0"
+classifiers=[
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Rust",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Development Status ::  5 - Production/Stable",
+]
+keywords = ["Networks", "network", "graph", "Graph Theory", "DAG"]
+
+[tool.setuptools]
+packages = ["rustworkx", "rustworkx.visualization"]
+include-package-data = true
+
+[tool.distutils.bdist_wheel]
+py-limited-api = "cp39"
+
+[[tool.setuptools-rust.ext-modules]]
+target = "rustworkx.rustworkx"
+path = "Cargo.toml"
+binding = "PyO3"
+
+[project.optional-dependencies]
+mpl = ["matplotlib>=3.0"]
+graphviz = ["pillow>=5.4"]
+# TODO: use self-referential rustworkx[mpl] and rustworkx[graphivz]
+# once it is better suported.
+all = [
+    "matplotlib>=3.0",
+    "pillow>=5.4",
+]
+
+[project.urls]
+issues = "https://github.com/Qiskit/rustworkx/issues"
+source = "https://github.com/Qiskit/rustworkx"
+documentation ="https://www.rustworkx.org/"
+releasenotes = "https://www.rustworkx.org/release_notes.html"
+
+[[project.authors]]
+name = "Matthew Treinish"
+email = "mtreinish@kortar.org"
+
+[[project.maintainers]]
+name = "Ivan Carvalho"
+email = "ivancarvalho@gatech.edu"
+
 [build-system]
-requires = ["setuptools", "wheel", "setuptools-rust"]
+requires = ["setuptools>=70.1.0", "setuptools-rust>=1.9"]
 build-backend = "setuptools.build_meta"
 
+[dependency-groups]
+test = [
+  "setuptools-rust",
+  "fixtures",
+  "testtools>=2.5.0",
+  "networkx>=2.5",
+  "stestr>=4.1",
+]
+lint = [
+    "black~=24.8",
+    "ruff~=0.6",
+    "setuptools-rust",
+    "typos~=1.28",
+]
+stubs = [
+    "mypy==1.11.2",
+    "typing-extensions>=4.4",
+]
+docs = [
+    "m2r2",
+    "sphinx>=5.0",
+    "jupyter-sphinx",
+    "pydot",
+    "pillow>=4.2.1",
+    "reno>=3.4.0",
+    "qiskit-sphinx-theme~=1.14.0rc1",
+    "matplotlib>=3.4",
+    "sphinx-reredirects",
+    "sphinxemoji",
+    "ipykernel",
+]
+
 [tool.black]
 line-length = 100
 target-version = ['py39', 'py310', 'py311', 'py312']
 
 [tool.ruff]
 line-length = 105 # more lenient than black due to long function signatures
-src = ["rustworkx", "setup.py", "retworkx", "tests"]
+src = ["rustworkx", "setup.py", "tests"]
 lint.select = [
     "E",   # pycodestyle
     "F",   # pyflakes

releasenotes/notes/0.11/prepare-0.11-af688e532712c830.yaml

@@ -70,11 +70,11 @@ features:
 
 fixes:
   - |
-    Fixed an issue with the :func:`~retworkx.generators.heavy_hex_graph`,
-    :func:`~retworkx.generators.directed_heavy_hex_graph`,
-    :func:`~retworkx.generators.heavy_square_graph`,
-    and :func:`~retworkx.generators.directed_heavy_square_graph` generator
+    Fixed an issue with the :func:`~rustworkx.generators.heavy_hex_graph`,
+    :func:`~rustworkx.generators.directed_heavy_hex_graph`,
+    :func:`~rustworkx.generators.heavy_square_graph`,
+    and :func:`~rustworkx.generators.directed_heavy_square_graph` generator
     functions. When the input parameter ``d`` was set to 1 these functions
     would previously raise a ``pyo3_runtime.PanicException`` instead of
     returning the expected graph (a single node). 
-    Fixed `#452 <https://github.com/Qiskit/retworkx/issues/452>`__
+    Fixed `#452 <https://github.com/Qiskit/rustworkx/issues/452>`__

releasenotes/notes/0.12/add-json-dump-func-91c43cb4a3cd6951.yaml

@@ -1,14 +1,14 @@
 ---
 features:
   - |
-    Added a new function, :func:`~.retworkx.node_link_json`, which is used to
+    Added a new function, :func:`~.rustworkx.node_link_json`, which is used to
     generate JSON node-link data representation of an input :class:`~.PyGraph`
     or :class:`~.PyDiGraph` object. For example, running::
 
-      import retworkx
+      import rustworkx
 
-      graph = retworkx.generators.path_graph(weights=['a', 'b', 'c'])
-      print(retworkx.node_link_json(graph, node_attrs=lambda n: {'label': n}))
+      graph = rustworkx.generators.path_graph(weights=['a', 'b', 'c'])
+      print(rustworkx.node_link_json(graph, node_attrs=lambda n: {'label': n}))
 
     will output a JSON payload equivalent (identical except for whitespace) to:
 

releasenotes/notes/0.13/graph-annotations-1d436930bf60c5c2.yaml

@@ -2,6 +2,6 @@
 features:
   - |
     Added partial type annotations to the library, including for the
-    :class:`~retworkx.PyDiGraph` and :class:`~retworkx.PyGraph` classes.
+    :class:`~rustworkx.PyDiGraph` and :class:`~rustworkx.PyGraph` classes.
     This enables statically type checking  with
     `mypy <http://mypy-lang.org>`__.

releasenotes/notes/farewell-retworkx-be18546ac0b0cbc2.yaml

@@ -0,0 +1,15 @@
+---
+deprecations:
+  - |
+    We are saying goodbye to the legacy ``retworkx`` package that operates as a
+    backwards compatibility alias for ``rustworkx``. It was originally marked as
+    deprecated in the 0.12.0 release and this will be its last release it is supported. The ``rustworkx`` name has now existed
+    longer than the ``retworkx`` name and the ``retworkx`` package is no longer needed.
+
+    This release will unpin the ``retworkx`` package from the ``rustworkx`` package.
+    Historically, we have release ``retworkx`` and `rustworkx` at the same time, with
+    ``retworkx`` being an alias to the same ``rustworkx`` package. This will no longer
+    be the case.
+
+    We encourage users to migrate to the new name. Thanks to all users that have
+    used ``retworkx`` since the early days of the project!

retworkx/__init__.py renamed to retworkx/retworkx/__init__.py

@@ -0,0 +1,52 @@
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+from setuptools import setup
+
+
+import sys
+import pathlib
+
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    # setuptools actually depends on this, so we can safely import it
+    import tomli as tomllib
+
+parent_dir = pathlib.Path(__file__).parent.parent
+
+with open(parent_dir / "README.md") as f:
+    original_readme = f.read()
+with open(parent_dir / "pyproject.toml", "rb") as f:
+    pyproject = tomllib.load(f)
+
+retworkx_readme_compat = f"""# retworkx
+
+`retworkx` is the **deprecated** package name for `rustworkx`. `retworkx` has been
+retired and will no longer receive updates. We recommend using `rustworkx` instead,
+it should be a drop-in replacement. Thanks to all users that have used `retworkx`
+since the early days of the project!
+
+{original_readme}
+"""
+
+setup(
+    name="retworkx",
+    version=pyproject["project"]["version"],
+    description=pyproject["project"]["description"],
+    long_description=retworkx_readme_compat,
+    long_description_content_type="text/markdown",
+    author=pyproject["project"]["authors"][0]["name"],
+    author_email=pyproject["project"]["authors"][0]["email"],
+    license=pyproject["project"]["license"],
+    classifiers=pyproject["project"]["classifiers"],
+    keywords=pyproject["project"]["keywords"],
+    project_urls=pyproject["project"]["urls"],
+    python_requires=pyproject["project"]["requires-python"],
+    install_requires=["rustworkx"],
+    extras_require=pyproject["project"]["optional-dependencies"],
+)