add basic pre-commit �config

Author: minrk

.gitignore

@@ -53,4 +53,4 @@ coverage.xml
 docs/_build/
 
 .ipynb_checkpoints
-.DS_Store
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+exclude: "(.*/)?secrets/.*"
+
+ci:
+  # pre-commit.ci will open PRs updating our hooks once a month
+  autoupdate_schedule: monthly
+
+repos:
+  # autoformat and lint Python code
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.1
+    hooks:
+      - id: ruff
+        types_or:
+          - python
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+        types_or:
+          - python
+
+  # Autoformat: markdown, yaml, javascript (see the file .prettierignore)
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.6.2
+    hooks:
+      - id: prettier
+
+  # Autoformat and linting, misc. details
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: check-executables-have-shebangs

LICENSE

@@ -21,4 +21,3 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

README.md

@@ -27,7 +27,6 @@ Python dependencies:
 
     pip install -r requirements.txt
 
-
 ### Upgrading
 
 To upgrade the deployment in-place:

config/nbviewer.yaml

@@ -15,15 +15,15 @@ memcached:
 
 nbviewer:
   extraArgs:
-  - '--cache-expiry-min=3600'
-  - '--cache-expiry-max=14400'
-  - "--content-security-policy=connect-src *" # https://github.com/jupyter/nbviewer/issues/797
-  - '--jupyter-js-widgets-version=2.1' # https://github.com/jupyter/nbviewer/issues/818
-  - '--jupyter-widgets-html-manager-version=0.15' # https://github.com/jupyter/nbviewer/issues/818
-  - >-
-    --NBViewer.extra_head_html=
-    <script defer data-domain="nbviewer.org" src="https://plausible.io/js/script.file-downloads.outbound-links.js"></script>
-    <script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
+    - "--cache-expiry-min=3600"
+    - "--cache-expiry-max=14400"
+    - "--content-security-policy=connect-src *" # https://github.com/jupyter/nbviewer/issues/797
+    - "--jupyter-js-widgets-version=2.1" # https://github.com/jupyter/nbviewer/issues/818
+    - "--jupyter-widgets-html-manager-version=0.15" # https://github.com/jupyter/nbviewer/issues/818
+    - >-
+      --NBViewer.extra_head_html=
+      <script defer data-domain="nbviewer.org" src="https://plausible.io/js/script.file-downloads.outbound-links.js"></script>
+      <script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
 
 statuspage:
   enabled: true

pyproject.toml

@@ -6,4 +6,12 @@ name = "nbviewer.org-deploy"
 addopts = "-v"
 testpaths = [
     "tests",
-]
+]
+
+[tool.ruff.lint]
+select = [
+    "E9", # syntax
+    "I", # isort
+    "UP", # pyupgrade
+    "F", # flake8
+]

statuspage/statuspage.py

@@ -1,64 +1,62 @@
 #!/usr/bin/env python3
 
-from datetime import datetime
 import json
 import os
 import sys
 import time
+from datetime import datetime
 
 import requests
- 
-api_key = os.environ['STATUSPAGE_API_KEY']
-page_id = os.environ['STATUSPAGE_PAGE_ID']
-metric_id = os.environ['STATUSPAGE_METRIC_ID']
-api_base = 'api.statuspage.io'
 
-github_id = os.environ['GITHUB_OAUTH_KEY']
-github_secret = os.environ['GITHUB_OAUTH_SECRET']
+api_key = os.environ["STATUSPAGE_API_KEY"]
+page_id = os.environ["STATUSPAGE_PAGE_ID"]
+metric_id = os.environ["STATUSPAGE_METRIC_ID"]
+api_base = "api.statuspage.io"
+
+github_id = os.environ["GITHUB_OAUTH_KEY"]
+github_secret = os.environ["GITHUB_OAUTH_SECRET"]
 
 
 def get_rate_limit():
     """Retrieve the current GitHub rate limit for our auth tokens"""
     r = requests.get(
-        'https://api.github.com/rate_limit',
-        auth=(github_id, github_secret)
+        "https://api.github.com/rate_limit", auth=(github_id, github_secret)
     )
     r.raise_for_status()
     resp = r.json()
-    return resp['resources']['core']
+    return resp["resources"]["core"]
 
 
 def post_data(limit, remaining, **ignore):
     """Send the percent-remaining GitHub rate limit to statuspage"""
     percent = 100 * remaining / limit
     now = int(datetime.utcnow().timestamp())
-    url = "https://api.statuspage.io/v1/pages/{page_id}/metrics/{metric_id}/data.json".format(
-        page_id=page_id, metric_id=metric_id,
-    )
-    
-    r = requests.post(url,
+    url = f"https://api.statuspage.io/v1/pages/{page_id}/metrics/{metric_id}/data.json"
+
+    r = requests.post(
+        url,
         headers={
             "Content-Type": "application/x-www-form-urlencoded",
             "Authorization": "OAuth " + api_key,
         },
         data={
-            'data[timestamp]': now,
-            'data[value]': percent,
-        }
+            "data[timestamp]": now,
+            "data[value]": percent,
+        },
     )
     r.raise_for_status()
 
 
 def get_and_post():
     data = get_rate_limit()
     print(json.dumps(data))
-    post_data(limit=data['limit'], remaining=data['remaining'])
+    post_data(limit=data["limit"], remaining=data["remaining"])
 
 
 while True:
     try:
         get_and_post()
     except Exception as e:
-        print("Error: %s" % e, file=sys.stderr)
+        print(f"Error: {e}", file=sys.stderr)
     # post every two minutes
     time.sleep(120)

tasks.py

@@ -1,36 +1,21 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 """
 Deploys nbviewer on helm
 
 """
 
-from __future__ import print_function
-
-from functools import lru_cache
-import json
-import os
-import pipes
-import re
-import socket
-import sys
-import time
-
-join = os.path.join
-
-from invoke import run, task
 import requests
-
+from invoke import task
 
 creds = {}
-with open('creds') as f:
+with open("creds") as f:
     exec(f.read(), creds)
 
 
 @task
 def trigger_build(ctx):
     url_base = "https://hub.docker.com/api/build/v1/source/579ab043-912f-425b-8b3f-765ee6143b53/trigger/{}/call/"
-    r = requests.post(url=url_base.format(creds['DOCKER_TRIGGER_TOKEN']))
+    r = requests.post(url=url_base.format(creds["DOCKER_TRIGGER_TOKEN"]))
     r.raise_for_status()
     print(r.text)
 
@@ -45,42 +30,40 @@ def doitall(ctx):
     2. upgrade on all machines
     """
     # make sure current repo is up to date
-    ctx.run('git pull', echo=True)
+    ctx.run("git pull", echo=True)
     upgrade(ctx)
     fastly(ctx)
 
 
 @task
 def upgrade(ctx, yes=False):
-    """Update helm deployment
-
-    """
+    """Update helm deployment"""
     raise NotImplementedError("Not implemented yet for helm")
 
 
 # ------- Fastly commands for updating the CDN --------
 
-FASTLY_API = 'https://api.fastly.com'
+FASTLY_API = "https://api.fastly.com"
 
 
 class FastlyService:
     def __init__(self, api_key, service_id):
         self.session = requests.Session()
-        self.session.headers['Fastly-Key'] = api_key
+        self.session.headers["Fastly-Key"] = api_key
         self.service_id = service_id
         latest_version = self.versions()[-1]
-        self.version = latest_version['number']
-        if latest_version['active']:
+        self.version = latest_version["number"]
+        if latest_version["active"]:
             # don't have an inactive version yet
-            self.api_request('/clone', method='PUT')
+            self.api_request("/clone", method="PUT")
             latest_version = self.versions()[-1]
-            self.version = latest_version['number']
+            self.version = latest_version["number"]
 
-    def api_request(self, path, include_version=True, method='GET', **kwargs):
+    def api_request(self, path, include_version=True, method="GET", **kwargs):
         url = "{api}/service/{service_id}{v}{path}".format(
             api=FASTLY_API,
             service_id=self.service_id,
-            v='/version/%i' % self.version if include_version else '',
+            v=f"/version/{self.version}" if include_version else "",
             path=path,
         )
         r = self.session.request(method, url, **kwargs)
@@ -92,78 +75,78 @@ def api_request(self, path, include_version=True, method='GET', **kwargs):
         return r.json()
 
     def backends(self):
-        return self.api_request('/backend')
+        return self.api_request("/backend")
 
     def versions(self):
-        return self.api_request('/version', include_version=False)
+        return self.api_request("/version", include_version=False)
 
     def add_backend(self, name, hostname, port, copy_backend=None):
         if copy_backend is None:
             copy_backend = self.backends()[0]
         data = {
             key: copy_backend[key]
             for key in [
-                'healthcheck',
-                'max_conn',
-                'weight',
-                'error_threshold',
-                'connect_timeout',
-                'between_bytes_timeout',
-                'first_byte_timeout',
-                'auto_loadbalance',
+                "healthcheck",
+                "max_conn",
+                "weight",
+                "error_threshold",
+                "connect_timeout",
+                "between_bytes_timeout",
+                "first_byte_timeout",
+                "auto_loadbalance",
             ]
         }
-        data.update({'address': hostname, 'name': name, 'port': port})
-        self.api_request('/backend', method='POST', data=data)
+        data.update({"address": hostname, "name": name, "port": port})
+        self.api_request("/backend", method="POST", data=data)
 
     def remove_backend(self, name):
-        self.api_request('/backend/%s' % name, method='DELETE')
+        self.api_request(f"/backend/{name}", method="DELETE")
 
     def deploy(self):
         # activate the current version
-        self.api_request('/activate', method='PUT')
+        self.api_request("/activate", method="PUT")
         # clone to a new version
-        self.api_request('/clone', method='PUT')
-        self.version = self.versions()[-1]['number']
+        self.api_request("/clone", method="PUT")
+        self.version = self.versions()[-1]["number"]
 
 
 def all_instances():
     """Return {(ip, port) : name} for all running nbviewer containers on all machines"""
     all_nbviewers = {}
     # add ovh by hand
     # TODO: get service from kubernetes
-    all_nbviewers[('135.125.83.237', 80)] = 'ovh'
+    all_nbviewers[("135.125.83.237", 80)] = "ovh"
     return all_nbviewers
 
 
 @task
 def fastly(ctx):
     """Update the fastly CDN"""
     print("Checking fastly backends")
-    f = FastlyService(creds['FASTLY_KEY'], creds['FASTLY_SERVICE_ID'])
+    f = FastlyService(creds["FASTLY_KEY"], creds["FASTLY_SERVICE_ID"])
     changed = False
     backends = f.backends()
     nbviewers = all_instances()
     existing_backends = set()
     # first, delete the backends we don't want
     copy_backend = backends[0]
     for backend in backends:
-        host = (backend['address'], backend['port'])
+        host = (backend["address"], backend["port"])
         if host not in nbviewers:
-            print("Deleting backend %s" % backend['name'])
-            f.remove_backend(backend['name'])
+            print(f"Deleting backend {backend['name']}")
+            f.remove_backend(backend["name"])
             changed = True
         else:
             existing_backends.add(host)
     for host, name in nbviewers.items():
         if host not in existing_backends:
             ip, port = host
-            print("Adding backend %s %s:%i" % (name, ip, port))
+            print(f"Adding backend {name} {ip}:{port}")
             f.add_backend(name, ip, port, copy_backend)
             changed = True
 
     if changed:
-        print("Activating fastly configuration %s" % f.version)
+        print(f"Activating fastly configuration {f.version}")
         f.deploy()
     else:
         print("Fastly OK")

tests/test_nbviewer.py

@@ -2,7 +2,6 @@
 import requests
 from bs4 import BeautifulSoup
 
-
 NBVIEWER = "https://nbviewer.org"
 
 frontpage_request = requests.get(NBVIEWER)