Maintenance cleanup (#325)

Author: blink1073

.flake8

@@ -7,6 +7,10 @@ on:
   schedule:
     - cron: "0 8 * * *"
 
+defaults:
+  run:
+    shell: bash -eux {0}
+
 jobs:
   test:
     name: ${{ matrix.os }} ${{ matrix.python-version }}
@@ -24,6 +28,8 @@ jobs:
             python-version: "3.9"
           - os: ubuntu-latest
             python-version: "pypy-3.7"
+          - os: ubuntu-latest
+            python-version: "3.11-dev"
           - os: macos-latest
             python-version: "3.8"
     steps:
@@ -37,59 +43,31 @@ jobs:
       - name: Run the tests
         if: ${{ !startsWith(matrix.python-version, 'pypy') && !startsWith(matrix.os, 'windows') }}
         run: |
-          args="-vv -raXs --cov jupyterlab_server --cov-branch --cov-report term-missing:skip-covered --durations 10 --color=yes --cov-fail-under 65"
-          python -m pytest $args || python -m pytest $args --lf
+          hatch run cov:test || hatch run test:test --lf
       - name: Run the tests on pypy and windows
         if: ${{ startsWith(matrix.python-version, 'pypy') || startsWith(matrix.os, 'windows') }}
         run: |
-          python -m pytest -vv -raXs || python -m pytest -vv -raXs --lf
+          hatch run test:test || hatch run test:test --lf
       - name: Upload coverage
         run: |
+          pip install codecov
           codecov
 
-  pre-commit:
-    name: Run pre-commit hook
+  pre_commit:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
       - name: Checkout
         uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - name: Run pre-commit
-        uses: pre-commit/[email protected]
-      - name: Help message if pre-commit fail
-        if: ${{ failure() }}
-        run: |
-          echo "You can install pre-commit hooks to automatically run formatting"
-          echo "on each commit with:"
-          echo "    pre-commit install"
-          echo "or you can run by hand on staged files with"
-          echo "    pre-commit run"
-          echo "or after-the-fact on already committed files with"
-          echo "    pre-commit run --all-files --hook-stage=manual"
+      - uses: jupyterlab/maintainer-tools/.github/actions/pre-commit@v1
 
   docs:
-    name: Docs Build
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Base Setup
-        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - uses: conda-incubator/setup-miniconda@v2
-        with:
-          auto-update-conda: true
-          activate-environment: jupyterlab_server_documentation
-          environment-file: docs/environment.yml
-      - name: Install lib
-        shell: bash -l {0}
-        run: |
-          pip install .
-      - name: Build docs
-        shell: bash -l {0}
-        run: |
-          pushd docs
-          make html SPHINXOPTS="-W"
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - run: hatch run docs:build
 
   check_release:
     runs-on: ubuntu-latest
@@ -119,7 +97,7 @@ jobs:
       - name: Install miniumum versions
         uses: jupyterlab/maintainer-tools/.github/actions/install-minimums@v1
       - name: Run the unit tests
-        run: python -m pytest -vv -raXs -W default || python -m pytest -vv -raXs -W default --lf
+        run: pytest -vv -W default || pytest -vv -W default --lf
 
   test_prereleases:
     name: Test Prereleases
@@ -138,47 +116,29 @@ jobs:
           pip freeze
           pip check
       - name: Run the tests
-        run: python -m pytest -vv -raXs -W default || python -m pytest -vv -raXs -W default --lf
+        run: pytest -W default || pytest -W default --lf
 
   make_sdist:
     name: Make SDist
     runs-on: ubuntu-latest
-    timeout-minutes: 20
+    timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v3
-      - name: Base Setup
-        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - name: Build SDist
-        run: |
-          pip install build
-          python -m build --sdist
-      - uses: actions/upload-artifact@v3
-        with:
-          name: "sdist"
-          path: dist/*.tar.gz
+      - uses: actions/checkout@v2
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - uses: jupyterlab/maintainer-tools/.github/actions/make-sdist@v1
 
   test_sdist:
     runs-on: ubuntu-latest
     needs: [make_sdist]
     name: Install from SDist and Test
     timeout-minutes: 20
     steps:
-      - name: Base Setup
-        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - name: Download sdist
-        uses: actions/download-artifact@v3
-      - name: Install From SDist
-        run: |
-          set -ex
-          cd sdist
-          mkdir test
-          tar --strip-components=1 -zxvf *.tar.gz -C ./test
-          cd test
-          pip install .[test]
-      - name: Run Test
-        run: |
-          cd sdist/test
-          python -m pytest -vv -raXs || python -m pytest -vv -raXs --lf
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - uses: jupyterlab/maintainer-tools/.github/actions/test-sdist@v1
+        with:
+          package_spec: .
+          test_command: hatch run test:test || hatch run test:test --lf
+      - run:
           # Ensure that the pytest plugin is importable.
           python -c "from jupyterlab_server import pytest_plugin"
 
@@ -189,3 +149,21 @@ jobs:
       - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
+
+  tests_check: # This job does nothing and is only used for the branch protection
+    if: always()
+    needs:
+      - test
+      - pre_commit
+      - check_links
+      - docs
+      - check_release
+      - test_miniumum_verisons
+      - test_prereleases
+      - test_sdist
+    runs-on: ubuntu-latest
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/tests.yml

@@ -52,10 +52,11 @@ repos:
         args: [--max-line-length=200]
         stages: [manual]
 
-  - repo: https://github.com/pycqa/flake8
-    rev: 5.0.4
+  - repo: https://github.com/john-hen/Flake8-pyproject
+    rev: 1.0.1
     hooks:
-      - id: flake8
+      - id: Flake8-pyproject
+        alias: flake8
         additional_dependencies:
           ["flake8-bugbear==22.6.22", "flake8-implicit-str-concat==0.2.0"]
         stages: [manual]

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+version: 2
+sphinx:
+  configuration: docs/source/conf.py
+python:
+  version: 3.8
+  install:
+    # install itself with pip install .
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

.readthedocs.yaml

@@ -15,8 +15,10 @@
 # sys.path.insert(0, os.path.abspath('.'))
 import os.path as osp
 import shutil
+import sys
 
 HERE = osp.abspath(osp.dirname(__file__))
+sys.path.insert(0, osp.join(HERE, "..", ".."))
 
 # -- Project information -----------------------------------------------------
 
@@ -43,7 +45,6 @@
 # ones.
 extensions = [
     "myst_parser",
-    "numpydoc",
     "autodoc_traits",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",

docs/environment.yml

@@ -49,6 +49,17 @@ Source = "https://github.com/jupyterlab/jupyterlab_server"
 Tracker = "https://github.com/jupyterlab/jupyterlab_server/issues"
 
 [project.optional-dependencies]
+docs = [
+  "autodoc-traits",
+  "docutils<0.19",
+  "pydata_sphinx_theme",
+  "sphinx",
+  "sphinx-copybutton",
+  "sphinxcontrib-openapi",
+  "myst-parser",
+  "mistune<1",
+  "jinja2<3.1.0"
+]
 openapi = [
   "openapi_core>=0.14.2",
   "ruamel.yaml",
@@ -69,9 +80,26 @@ test = [
 
 [tool.hatch.version]
 path = "jupyterlab_server/_version.py"
+validate-bump = false
+
+[tool.hatch.envs.docs]
+features = ["docs"]
+[tool.hatch.envs.docs.scripts]
+build = "make -C docs html SPHINXOPTS='-W'"
 
-[tool.jupyter-releaser]
-skip = ["check-links"]
+[tool.hatch.envs.test]
+features = ["test"]
+[tool.hatch.envs.test.scripts]
+test = "python -m pytest -vv {args}"
+nowarn = "python -m pytest -vv -W default {args}"
+
+[tool.hatch.envs.cov]
+features = ["test"]
+dependencies = ["coverage", "pytest-cov"]
+[tool.hatch.envs.cov.env-vars]
+ARGS = "-vv --cov jupyterlab_server --cov-branch --cov-report term-missing:skip-covered"
+[tool.hatch.envs.cov.scripts]
+test = "python -m pytest $ARGS --cov-fail-under 65 {args}"
 
 [tool.pytest.ini_options]
 addopts = "-raXs --durations 10 --color=yes --doctest-modules"
@@ -89,3 +117,24 @@ filterwarnings = [
   "ignore:Passing a schema to Validator.iter_errors:DeprecationWarning",
   "module:Subclassing validator classes is not intended to be part of their public API:DeprecationWarning"
 ]
+
+[tool.flake8]
+ignore = "E501, W503, E402"
+builtins = "c, get_config"
+exclude = [
+    ".cache",
+    ".github",
+    "docs",
+    "setup.py",
+]
+enable-extensions = "G"
+extend-ignore = [
+    "G001", "G002", "G004", "G200", "G201", "G202",
+    # black adds spaces around ':'
+    "E203",
+]
+per-file-ignores = [
+    # B011: Do not call assert False since python -O removes these calls
+    # F841 local variable 'foo' is assigned to but never used
+    "tests/*: B011", "F841",
+]