Merge pull request #551 from minrk/pyproject

add PEP 621 build info, require Python 3.10

Author: manics

.github/workflows/test.yaml

@@ -34,7 +34,7 @@ jobs:
           # jupyterhub 4 works with pytest-asyncio 0.25
           # but requires some deprecated features,
           # so don't let it upgrade further
-          - python-version: "3.9"
+          - python-version: "3.10"
             pip-install-spec: "jupyterhub==4.* sqlalchemy==1.* pytest-asyncio==0.25.*"
           - python-version: "3.11"
             pip-install-spec: "jupyterhub==4.* pytest-asyncio==0.25.*"
@@ -52,15 +52,14 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - uses: actions/setup-node@v6
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: setup docker swarm
         run: docker swarm init
 
       - name: Install Python dependencies
         run: |
-          pip install ${{ matrix.pip-install-spec }}
-          pip install -e "." -r dev-requirements.txt
+          pip install ${{ matrix.pip-install-spec }} -e ".[test]"
 
       - name: List Python dependencies
         run: |

.pre-commit-config.yaml

@@ -12,8 +12,6 @@ repos:
     rev: v3.21.2
     hooks:
       - id: pyupgrade
-        args:
-          - --py38-plus
 
   # Autoformat: Python code
   - repo: https://github.com/PyCQA/autoflake
@@ -45,8 +43,8 @@ repos:
           - setuptools
 
   # Autoformat: markdown, yaml
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v4.0.0-alpha.8
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.7.3
     hooks:
       - id: prettier
 

MANIFEST.in

@@ -1,7 +1,8 @@
 FROM jupyterhub/jupyterhub:5
 
-COPY pyproject.toml setup.py requirements.txt /src/dockerspawner/
-COPY dockerspawner /src/dockerspawner/dockerspawner
-RUN pip install /src/dockerspawner
+# install dockerspawner from this repo
+# alternatively: pip install dockerspawner to get the stable release
+COPY ./ dockerspawner /src/dockerspawner
+RUN pip install --no-cache /src/dockerspawner
 
 COPY examples/internal-ssl/jupyterhub_config.py /srv/jupyterhub/jupyterhub_config.py

dev-requirements.txt

@@ -1,4 +1,4 @@
-ARG JUPYTERHUB_VERSION=1.3
+ARG JUPYTERHUB_VERSION=5
 FROM jupyterhub/jupyterhub:$JUPYTERHUB_VERSION
 COPY requirements.txt /tmp/requirements.txt
 RUN python3 -m pip install --no-cache -r /tmp/requirements.txt

examples/internal-ssl/Dockerfile

@@ -1,2 +1 @@
 dockerspawner
-jupyterhub-dummyauthenticator

examples/simple/Dockerfile

@@ -1,10 +1,10 @@
 # base image: jupyterhub
 # this is built by docker-compose
 # from the root of this repo
-ARG JUPYTERHUB_VERSION=2.2
+ARG JUPYTERHUB_VERSION=5
 FROM jupyterhub/jupyterhub:${JUPYTERHUB_VERSION}
 # install dockerspawner from the current repo
-ADD . /tmp/dockerspawner
+COPY . /tmp/dockerspawner
 RUN pip install --no-cache /tmp/dockerspawner
 # load example configuration
-ADD examples/swarm/jupyterhub_config.py /srv/jupyterhub/jupyterhub_config.py
+COPY examples/swarm/jupyterhub_config.py /srv/jupyterhub/jupyterhub_config.py

examples/simple/requirements.txt

@@ -1,3 +1,64 @@
+[build-system]
+requires = [
+  "hatchling",
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "dockerspawner"
+dynamic = [
+  "version",
+]
+description = "Dockerspawner: A custom spawner for JupyterHub using Docker"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "BSD-3-Clause"
+authors = [
+  { name = "Jupyter Development Team", email = "[email protected]" },
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "Intended Audience :: Science/Research",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Operating System :: POSIX",
+  "Framework :: Jupyter",
+]
+keywords = [
+  "docker",
+  "jupyter",
+  "jupyterhub",
+]
+dependencies = [
+  "docker",
+  "escapism",
+  "jupyterhub>=4",
+]
+
+[project.urls]
+Documentation = "https://jupyterhub-dockerspawner.readthedocs.io"
+Source = "https://github.com/jupyterhub/dockerspawner"
+Issues = "https://github.com/jupyterhub/dockerspawner/issues"
+
+[project.optional-dependencies]
+test = [
+  "psutil",
+  "pytest",
+  "pytest-asyncio>=0.25",
+  "pytest-cov",
+]
+
+[project.entry-points."jupyterhub.spawners"]
+docker = "dockerspawner:DockerSpawner"
+docker-system-user = "dockerspawner:SystemUserSpawner"
+docker-swarm = "dockerspawner:SwarmSpawner"
+
+[tool.hatch.version]
+path = "dockerspawner/_version.py"
+
+
 # autoflake is used for autoformatting Python code
 #
 # ref: https://github.com/PyCQA/autoflake#readme
@@ -23,11 +84,6 @@ profile = "black"
 #
 [tool.black]
 skip-string-normalization = true
-target_version = [
-    "py39",
-    "py310",
-    "py311",
-]
 
 
 # pytest is used for running Python based tests
@@ -38,15 +94,17 @@ target_version = [
 addopts = "--verbose --color=yes --durations=10 --maxfail=1"
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "module"
-testpaths = ["tests"]
+testpaths = [
+  "tests",
+]
 # These markers are registered to avoid warnings triggered by importing from
 # jupyterhub.tests.test_api.
 markers = [
-    "role",
-    "user",
-    "slow",
-    "group",
-    "services",
+  "role",
+  "user",
+  "slow",
+  "group",
+  "services",
 ]