Add pre-commit config and configure autoformating tools and pytest from pyproject.toml

.flake8

@@ -0,0 +1,13 @@
+# flake8 is used for linting Python code setup to automatically run with
+# pre-commit.
+#
+# ref: https://flake8.pycqa.org/en/latest/user/configuration.html
+#
+
+[flake8]
+# E: style errors
+# W: style warnings
+# C: complexity
+# D: docstring warnings (unused pydocstyle extension)
+# F841: local variable assigned but never used
+ignore = E, C, W, D, F841

.github/workflows/release.yml

@@ -20,23 +20,23 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.10"
-    - name: Install build package
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-        pip freeze
-    - name: Build release
-      run: |
-        python -m build --sdist --wheel .
-        ls -l dist
-    - name: Publish to PyPI
-      uses: pypa/[email protected]
-      if: startsWith(github.ref, 'refs/tags/')
-      with:
-        user: __token__
-        password: ${{ secrets.pypi_password }}
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install build package
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+          pip freeze
+      - name: Build release
+        run: |
+          python -m build --sdist --wheel .
+          ls -l dist
+      - name: Publish to PyPI
+        uses: pypa/[email protected]
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_password }}

.pre-commit-config.yaml

@@ -0,0 +1,75 @@
+# pre-commit is a tool to perform a predefined set of tasks manually and/or
+# automatically before git commits are made.
+#
+# Config reference: https://pre-commit.com/#pre-commit-configyaml---top-level
+#
+# Common tasks
+#
+# - Run on all files:   pre-commit run --all-files
+# - Register git hooks: pre-commit install --install-hooks
+#
+exclude: 'versioneer\.py|_version\.py'
+
+repos:
+  # Autoformat: Python code, syntax patterns are modernized
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.3.1
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py38-plus
+
+  # Autoformat: Python code
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.0.1
+    hooks:
+      - id: autoflake
+        # args ref: https://github.com/PyCQA/autoflake#advanced-usage
+        args:
+          - --in-place
+
+  # Autoformat: Python code
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  # Autoformat: Python code
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+
+  # Autoformat: markdown, yaml
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.0-alpha.4
+    hooks:
+      - id: prettier
+
+  # Misc...
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    # ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available
+    hooks:
+      # Autoformat: Makes sure files end in a newline and only a newline.
+      - id: end-of-file-fixer
+
+      # Autoformat: Sorts entries in requirements.txt.
+      - id: requirements-txt-fixer
+
+      # Lint: Check for files with names that would conflict on a
+      # case-insensitive filesystem like MacOS HFS+ or Windows FAT.
+      - id: check-case-conflict
+
+      # Lint: Checks that non-binary executables have a proper shebang.
+      - id: check-executables-have-shebangs
+
+  # Lint: Python code
+  - repo: https://github.com/PyCQA/flake8
+    rev: "6.0.0"
+    hooks:
+      - id: flake8
+
+# pre-commit.ci config reference: https://pre-commit.ci/#configuration
+ci:
+  autoupdate_schedule: monthly

CONTRIBUTING.md

@@ -6,7 +6,7 @@ Make sure to also follow [Project Jupyter's Code of Conduct](https://github.com/
 
 ## Setting up for local development
 
-This package requires Python >= 3.5.
+This package requires Python >= 3.6.
 
 As a Python package, you can set up a development environment by cloning this repo and running:
 
@@ -18,24 +18,18 @@ You can also install the tools we use for testing and development with:
 
     python3 -m pip install -r dev-requirements.txt
 
+### Auto-format with pre-commit
 
-### Auto-format with black
+We use the [pre-commit](https://pre-commit.com) tool for autoformatting.
 
-We are trying out the [black](https://github.com/ambv/black) auto-formatting
-tool on this repo.
+You can install and enable it with:
 
-You can run `black` manually on the repo with:
-
-    black .
-
-in the root of the repo. You can also enable this automatically on each commit
-by installing a pre-commit hook:
-
-    ./git-hooks/install
+    pip install pre-commit
+    pre-commit install
 
 After doing this, every time you make a commit,
-the `black` autoformatter will run,
-ensuring consistent style without you having to worry too much about style.
+`pre-commit` will run autoformatting.
+If it makes any changes, it'll let you know and you can make the commit again with the autoformatting changes.
 
 ## Running the tests
 

README.md

@@ -1,4 +1,3 @@
-
 # JupyterHub Traefik Proxy
 
 [![Documentation build status](https://img.shields.io/readthedocs/jupyterhub-traefik-proxy?logo=read-the-docs)](https://jupyterhub-traefik-proxy.readthedocs.org/en/latest/)
@@ -19,12 +18,12 @@ depending on how traefik store its routing configuration.
 
 For **smaller**, single-node deployments:
 
-* TraefikFileProviderProxy
+- TraefikFileProviderProxy
 
 For **distributed** setups:
 
-* TraefikEtcdProxy
-* TraefikConsulProxy
+- TraefikEtcdProxy
+- TraefikConsulProxy
 
 ## Installation
 
@@ -33,22 +32,21 @@ The [documentation](https://jupyterhub-traefik-proxy.readthedocs.io) contains a
 guide](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/install.html)
 with examples for the three different implementations.
 
-* [For TraefikFileProviderProxy](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/file.html#example-setup)
-* [For TraefikEtcdProxy](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/etcd.html#example-setup)
-* [For TraefikConsulProxy](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/consul.html#example-setup)
-
+- [For TraefikFileProviderProxy](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/file.html#example-setup)
+- [For TraefikEtcdProxy](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/etcd.html#example-setup)
+- [For TraefikConsulProxy](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/consul.html#example-setup)
 
 ## Running tests
 
-There are some tests that use *etcdctl* command line client for etcd. Make sure
+There are some tests that use _etcdctl_ command line client for etcd. Make sure
 to set environment variable `ETCDCTL_API=3` before running the tests, so that
 the v3 API to be used, e.g.:
 
 ```
 $ export ETCDCTL_API=3
 ```
 
-You can then run the all the test suite from the *traefik-proxy* directory with:
+You can then run the all the test suite from the _traefik-proxy_ directory with:
 
 ```
 $ pytest -v ./tests

dev-requirements.txt

@@ -1,10 +1,5 @@
-pytest
-pytest-asyncio
-pytest-cov
-codecov
 black
-notebook>=4.0
-websockets
+codecov
 # etcd3 & python-consul2 are now soft dependencies
 # Adding them here prevents CI from failing
 
@@ -13,4 +8,9 @@ websockets
 # but with updated grpcio compatibility
 # watch this space to pick a winner...
 etcdpy
+notebook>=4.0
+pytest
+pytest-asyncio
+pytest-cov
 python-consul2
+websockets

docs/Makefile

@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)