breaking: require py37+ and jupyterhub 1.5.1+, test jupyterhub 4

Author: consideRatio

.github/workflows/test.yaml

@@ -1,21 +1,19 @@
 # This is a GitHub workflow defining a set of jobs with a set of steps.
-# ref: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
+# ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
 #
 name: Test
 
 on:
   pull_request:
     paths-ignore:
       - "**.md"
-      - "**.yml"
-      - "**.yaml"
-      - "!.github/workflows/test.yml"
+      - ".github/workflows/*.yaml"
+      - "!.github/workflows/test.yaml"
   push:
     paths-ignore:
       - "**.md"
-      - "**.yml"
-      - "**.yaml"
-      - "!.github/workflows/test.yml"
+      - ".github/workflows/*.yaml"
+      - "!.github/workflows/test.yaml"
     branches-ignore:
       - "dependabot/**"
       - "pre-commit-ci-update-config"
@@ -24,65 +22,55 @@ on:
 
 jobs:
   pytest:
-    name: "Run pytest"
-    runs-on: ubuntu-20.04
-    continue-on-error: ${{ matrix.allow_failure }}
+    name: Run pytest
+    runs-on: ubuntu-22.04
+
     strategy:
-      # Keep running even if one variation of the job fail
       fail-fast: false
       matrix:
-        python-version:
-          - "3.6"
-          - "3.10"
-        JHUB_VER:
-          - "1.0.0"
-          - "1.5.1"
-          - "2.3.1"
-        allow_failure: [false]
-
-        exclude:
-          # JupyterHub 1.3.0 requires python 3.6+
-          - JHUB_VER: "1.3.0"
-            python-version: "3.5"
-          # JupyterHub 0.9.6 used a deprecated sqlalchemy feature removed in py3.9 environment
-          - JHUB_VER: "0.9.6"
-            python-version: "3.9"
         include:
-          - JHUB_VER: "main"
-            python-version: "3.9"
-            allow_failure: true
-          - JHUB_VER: "3.0.0"
-            python-version: "3.9"
-            allow_failure: true
+          # test oldest supported version
+          - python-version: "3.7"
+            pip-install-spec: "jupyterhub==1.5.1 sqlalchemy==1.*"
+
+          - python-version: "3.8"
+            pip-install-spec: "jupyterhub==2.* sqlalchemy==1.*"
+          - python-version: "3.10"
+            pip-install-spec: "jupyterhub==3.*"
+          - python-version: "3.11"
+            pip-install-spec: "jupyterhub==4.*"
+
+          # test unreleased jupyterhub, failures tolerated
+          - python-version: "3.X"
+            pip-install-spec: "git+https://github.com/jupyterhub/jupyterhub"
+            allow-failure: true
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+      - uses: actions/setup-python@v4
         with:
           python-version: "${{ matrix.python-version }}"
 
-      - name: Install dependencies
+      - name: Install Node dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install pytest
-          pip install -r requirements.txt
-          pip list
+          npm install -g configurable-http-proxy
 
-      - name: Install nodejs dependencies
+      - name: Install Python dependencies
         run: |
-          sudo npm install -g configurable-http-proxy
+          pip install --upgrade pip
+          pip install ${{ matrix.pip-install-spec }}
+          pip install -e ".[test]"
 
-      # We need to check compatibility with different versions of the JH API,
-      # including latest development.  For that, we also need to pull in the
-      # development dependencies of that old JH version (but we don't need
-      # conda/npm for our tests).
-      - name: install JupyterHub
+      - name: List dependencies
         run: |
-          git clone --quiet --branch ${{ matrix.JHUB_VER }} https://github.com/jupyterhub/jupyterhub.git ./jupyterhub
-          pip install -r ./jupyterhub/dev-requirements.txt
-          pip install ./jupyterhub
+          pip freeze
 
       - name: pytest
         run: |
           pytest --verbose --color=yes --last-failed --cov batchspawner batchspawner/tests
+
+      # GitHub action reference: https://github.com/codecov/codecov-action
+      - uses: codecov/codecov-action@v3

MANIFEST.in

@@ -1,4 +1,3 @@
 include *.md
 include LICENSE
 include version.py
-include requirements.txt

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

requirements.txt

@@ -1,48 +1,28 @@
-#!/usr/bin/env python
-# coding: utf-8
-
-# Copyright (c) Jupyter Development Team.
-# Distributed under the terms of the Modified BSD License.
-
-# -----------------------------------------------------------------------------
-# Minimal Python version sanity check (from IPython/Jupyterhub)
-# -----------------------------------------------------------------------------
-
-from __future__ import print_function
-
-import os
-import sys
-
 from setuptools import setup
-from glob import glob
 
-pjoin = os.path.join
-here = os.path.abspath(os.path.dirname(__file__))
+with open("README.md") as f:
+    long_description = f.read()
 
 # Get the current package version.
 version_ns = {}
-with open(pjoin(here, "version.py")) as f:
+with open("version.py") as f:
     exec(f.read(), {}, version_ns)
 
-with open(pjoin(here, "README.md"), encoding="utf-8") as f:
-    long_desc = f.read()
-
-setup_args = dict(
+setup(
     name="batchspawner",
     entry_points={
         "console_scripts": ["batchspawner-singleuser=batchspawner.singleuser:main"],
     },
     packages=["batchspawner"],
     version=version_ns["__version__"],
     description="""Batchspawner: A spawner for Jupyterhub to spawn notebooks using batch resource managers.""",
-    long_description=long_desc,
+    long_description=long_description,
     long_description_content_type="text/markdown",
     author="Michael Milligan, Andrea Zonca, Mike Gilbert",
     author_email="milligan@umn.edu",
     url="http://jupyter.org",
     license="BSD",
     platforms="Linux, Mac OS X",
-    python_requires="~=3.5",
     keywords=["Interactive", "Interpreter", "Shell", "Web", "Jupyter"],
     classifiers=[
         "Intended Audience :: Developers",
@@ -58,22 +38,16 @@
         "About Jupyterhub": "http://jupyterhub.readthedocs.io/en/latest/",
         "Jupyter Project": "http://jupyter.org",
     },
+    python_requires=">=3.7",
+    install_require={
+        "async_generator>=1.8",
+        "jinja2",
+        "jupyterhub>=1.5.1",
+    },
+    extras_require={
+        "test": [
+            "pytest",
+            "pytest-cov",
+        ],
+    },
 )
-
-# setuptools requirements
-if "setuptools" in sys.modules:
-    setup_args["install_requires"] = install_requires = []
-    with open("requirements.txt") as f:
-        for line in f.readlines():
-            req = line.strip()
-            if not req or req.startswith(("-e", "#")):
-                continue
-            install_requires.append(req)
-
-
-def main():
-    setup(**setup_args)
-
-
-if __name__ == "__main__":
-    main()