Merge pull request #1458 from lixiname/main

build: migrate from setup.py to pyproject.toml

Author: minrk

.github/workflows/release.yml

@@ -85,7 +85,7 @@ jobs:
           echo "REGISTRY=$REGISTRY" >> $GITHUB_ENV
           echo "Publishing to $REGISTRY"
 
-      # versioneer requires the full git history for non-tags
+      # git requires the full git history for non-tags
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
@@ -111,7 +111,8 @@ jobs:
       # also push jupyter/repo2docker:1.2.3-3.abcd1234 (replace + with -)
       - name: Get list of repo2docker docker tags
         run: |
-          VERSION=$(python3 -c 'import versioneer; print(versioneer.get_version().replace("+", "-"))')
+          pip install setuptools-scm
+          VERSION=$(python3 -m setuptools_scm | sed s@+@-@g)
           TAGS="${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:$VERSION"
           if [ "${{ github.ref }}" == "refs/heads/main" ]; then
             TAGS="$TAGS,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:main"

.gitignore

@@ -191,3 +191,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# generated by setuptools_scm
+repo2docker/_version.py

MANIFEST.in

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "jupyter-repo2docker"
+dynamic = ["version"]
+description = "repo2docker: Turn code repositories into Jupyter enabled Docker Images"
+readme = "README.md"
+license = "BSD-3-Clause"
+authors = [
+    {name = "Project Jupyter Contributors", email = "[email protected]"}
+]
+maintainers = [
+    {name = "Project Jupyter Contributors", email = "[email protected]"}
+]
+keywords = ["reproducible", "science", "environments", "docker"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development",
+    "Topic :: System :: Systems Administration",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "chardet",
+    "docker!=5.0.0",
+    "entrypoints",
+    "escapism",
+    "iso8601",
+    "jinja2",
+    "python-json-logger",
+    "requests",
+    "ruamel.yaml>=0.15",
+    "semver",
+    "toml",
+    "traitlets",
+]
+
+[project.urls]
+Homepage = "https://repo2docker.readthedocs.io"
+Documentation = "https://repo2docker.readthedocs.io"
+Funding = "https://jupyter.org/about#donate"
+Source = "https://github.com/jupyterhub/repo2docker"
+Tracker = "https://github.com/jupyterhub/repo2docker/issues"
+
+[project.scripts]
+jupyter-repo2docker = "repo2docker.__main__:main"
+repo2docker = "repo2docker.__main__:main"
+
+[project.entry-points."repo2docker.engines"]
+docker = "repo2docker.docker:DockerEngine"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = [""]
+include = ["repo2docker"]
+
+
+[tool.setuptools_scm]
+write_to = "repo2docker/_version.py"

pyproject.toml

@@ -1,9 +1,9 @@
-from ._version import get_versions
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "0.0.0+unknown"
 
-__version__ = get_versions()["version"]
-del get_versions
-
-from . import _version
 from .app import Repo2Docker
 
-__version__ = _version.get_versions()["version"]
+# You can add this if you want an __all__ variable to control imports
+__all__ = ["__version__", "Repo2Docker"]