Merge pull request #390 from consideRatio/pr/pre-commit

pre-commit: add config and small fixes

Author: yuvipanda

.flake8

@@ -0,0 +1,12 @@
+# 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)
+ignore = E, C, W, D

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+# 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
+#
+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.2
+    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.3.0
+    hooks:
+      - id: black
+        exclude: "contrib\/template\/.*"
+
+  # Autoformat: markdown, yaml
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.0-alpha.6
+    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

@@ -90,12 +90,12 @@ jlpm run watch
 jupyter lab
 ```
 
-With the watch command running, every saved change will immediately be built locally 
-and available in your running JupyterLab. Refresh JupyterLab to load the change in 
+With the watch command running, every saved change will immediately be built locally
+and available in your running JupyterLab. Refresh JupyterLab to load the change in
 your browser (you may need to wait several seconds for the extension to be rebuilt).
 
-By default, the `jlpm run build` command generates the source maps for this 
-extension to make it easier to debug using the browser dev tools. To also generate 
+By default, the `jlpm run build` command generates the source maps for this
+extension to make it easier to debug using the browser dev tools. To also generate
 source maps for the JupyterLab core extensions, you can run the following command:
 
 ```bash

README.md

@@ -48,13 +48,13 @@ Jupyter Server within a container and only allow network access to the Jupyter
 Server via the container.
 
 > For more insights, see [Ryan Lovett's comment about
-it](https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197).
+> it](https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197).
 
 ## Install
 
 ### Requirements
 
-* `jupyterlab>=2` or `notebook`
+- `jupyterlab>=2` or `notebook`
 
 ### Python package
 

contrib/code-server-traitlet/jupyter_notebook_config.py

@@ -1,14 +1,16 @@
+# load the config object for traitlets based configuration
+c = get_config()  # noqa
+
+
 c.ServerProxy.servers = {
-  'code-server': {
-    'command': [
-      'code-server',
-        '--auth=none',
-        '--disable-telemetry',
-        '--bind-addr=localhost:{port}'
-    ],
-    'timeout': 20,
-    'launcher_entry': {
-      'title': 'VS Code'
+    "code-server": {
+        "command": [
+            "code-server",
+            "--auth=none",
+            "--disable-telemetry",
+            "--bind-addr=localhost:{port}",
+        ],
+        "timeout": 20,
+        "launcher_entry": {"title": "VS Code"},
     }
-  }
 }

contrib/template/cookiecutter.json

@@ -1,5 +1,5 @@
 {
-    "project_name": "",
-    "author_name": "Project Jupyter Contributors",
-    "author_email": "projectjupyter@gmail.com"
+  "project_name": "",
+  "author_name": "Project Jupyter Contributors",
+  "author_email": "projectjupyter@gmail.com"
 }

contrib/template/{{cookiecutter.project_name}}/jupyter_{{cookiecutter.project_name}}_proxy/__init__.py

@@ -6,6 +6,7 @@
 """
 import os
 
+
 def setup_{{cookiecutter.project_name}}():
     return {
         'command': [],

contrib/theia/jupyter_theia_proxy/__init__.py

@@ -7,21 +7,22 @@
 import os
 import shutil
 
+
 def setup_theia():
     # Make sure theia is in $PATH
     def _theia_command(port):
-        full_path = shutil.which('theia')
+        full_path = shutil.which("theia")
         if not full_path:
-            raise FileNotFoundError('Can not find theia executable in $PATH')
-        return ['theia', 'start', '.', '--hostname=127.0.0.1', '--port=' + str(port)]
+            raise FileNotFoundError("Can not find theia executable in $PATH")
+        return ["theia", "start", ".", "--hostname=127.0.0.1", "--port=" + str(port)]
 
     return {
-        'command': _theia_command,
-        'environment': {
-            'USE_LOCAL_GIT': 'true'
+        "command": _theia_command,
+        "environment": {"USE_LOCAL_GIT": "true"},
+        "launcher_entry": {
+            "title": "Theia IDE",
+            "icon_path": os.path.join(
+                os.path.dirname(os.path.abspath(__file__)), "icons", "theia.svg"
+            ),
         },
-        'launcher_entry': {
-            'title': 'Theia IDE',
-            'icon_path': os.path.join(os.path.dirname(os.path.abspath(__file__)), 'icons', 'theia.svg')
-        }
-    }
+    }

contrib/theia/setup.py

@@ -2,22 +2,20 @@
 
 setuptools.setup(
     name="jupyter-theia-proxy",
-    version='1.0dev',
+    version="1.0dev",
     url="https://github.com/jupyterhub/jupyter-server-proxy/tree/HEAD/contrib/theia",
     author="Project Jupyter Contributors",
     description="projectjupyter@gmail.com",
     packages=setuptools.find_packages(),
-	keywords=['Jupyter'],
-	classifiers=['Framework :: Jupyter'],
-    install_requires=[
-        'jupyter-server-proxy'
-    ],
+    keywords=["Jupyter"],
+    classifiers=["Framework :: Jupyter"],
+    install_requires=["jupyter-server-proxy"],
     entry_points={
-        'jupyter_serverproxy_servers': [
-            'theia = jupyter_theia_proxy:setup_theia',
+        "jupyter_serverproxy_servers": [
+            "theia = jupyter_theia_proxy:setup_theia",
         ]
     },
     package_data={
-        'jupyter_theia_proxy': ['icons/*'],
+        "jupyter_theia_proxy": ["icons/*"],
     },
 )

docs/source/arbitrary-ports-hosts.rst

@@ -90,4 +90,4 @@ accessing it from a classic notebook extension.
    // Construct URL of our proxied service
    let service_url = base_url + 'proxy/' + port;
 
-   // Do stuff with your service_url
+   // Do stuff with your service_url