Merge pull request #118 from mathbunnyru/asalikhov/cleanup

Add linters and do a general cleanup

Author: manics

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 88
+select = C,E,F,W,B,B950
+extend-ignore = E203, E501, W503

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

.github/workflows/test.yml

@@ -4,6 +4,9 @@
 name: Tests
 
 on:
+  schedule:
+    # Weekly, at 03:00 on Monday UTC time
+    - cron: "0 3 * * 1"
   pull_request:
   push:
   workflow_dispatch:

.gitignore

@@ -1,3 +1,4 @@
 secrets/
 userlist
 .DS_Store
+__pycache__/

.pre-commit-config.yaml

@@ -11,7 +11,7 @@
 repos:
   # Autoformat: Python code
   - repo: https://github.com/psf/black
-    rev: 22.8.0
+    rev: 23.1.0
     hooks:
       - id: black
         args:
@@ -21,6 +21,34 @@ repos:
 
   # Autoformat: markdown, yaml
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.7.1
+    rev: v3.0.0-alpha.4
     hooks:
       - id: prettier
+
+  # `pre-commit sample-config` default hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  # Lint: Dockerfile
+  - repo: https://github.com/hadolint/hadolint.git
+    rev: v2.12.1-beta
+    hooks:
+      - id: hadolint-docker
+        entry: hadolint/hadolint:v2.12.1-beta hadolint
+
+  # Lint: Python
+  - 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
+  # Docker hooks do not work in pre-commit.ci
+  # See: <https://github.com/pre-commit-ci/issues/issues/11>
+  skip: [hadolint-docker]

CONTRIBUTING.md

@@ -1,3 +1,3 @@
 # Contributing
 
-Welcome! As a [Jupyter](https://jupyter.org) project, we follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html).
+Welcome! As a [Jupyter](https://jupyter.org) project, we follow the [Jupyter contributor guide](https://docs.jupyter.org/en/latest/contributing/content-contributor.html).

README.md

@@ -73,7 +73,7 @@ You can configure JupyterHub to spawn Notebook servers from any Docker image, as
 long as the image's `ENTRYPOINT` and/or `CMD` starts a single-user instance of
 Jupyter Notebook server that is compatible with JupyterHub.
 
-To specify which Notebook image to spawn for users, you set the value of the  
+To specify which Notebook image to spawn for users, you set the value of the
 `DOCKER_NOTEBOOK_IMAGE` environment variable to the desired container image.
 
 Whether you build a custom Notebook image or pull an image from a public or
@@ -105,11 +105,7 @@ To run the JupyterHub container in detached mode:
 docker-compose up -d
 ```
 
-Once the container is running, you should be able to access the JupyterHub console at
-
-```
-http://localhost:8000
-```
+Once the container is running, you should be able to access the JupyterHub console at `http://localhost:8000`.
 
 To bring down the JupyterHub container:
 

ci/check_hub.sh

@@ -10,7 +10,7 @@ while [ $count -lt 60 ]; do
         started=1
         break
     fi
-    echo -n .
+    printf .
     count=$((count+1))
 done
 if [ $started -eq 0 ]; then

ci/config_token.py

@@ -1,12 +1,12 @@
-c.JupyterHub.load_roles = [
+c.JupyterHub.load_roles = [  # noqa: F821
     {
         "name": "test-admin",
         "scopes": ["admin:users", "admin:servers", "access:servers"],
         "services": ["test"],
     }
 ]
 
-c.JupyterHub.services = [
+c.JupyterHub.services = [  # noqa: F821
     {
         "name": "test",
         "api_token": "test-token-123",

docker-compose.yml

@@ -10,7 +10,7 @@ services:
       context: .
       dockerfile: Dockerfile.jupyterhub
       args:
-        JUPYTERHUB_VERSION: 3.0.0
+        JUPYTERHUB_VERSION: latest
     restart: always
     image: jupyterhub
     container_name: jupyterhub