Add pre-commit GitHub workflow, add "Getting started" docs

.devcontainer/Dockerfile

@@ -15,7 +15,7 @@ USER $USER
 ENV PATH "$PATH:/home/$USER/.local/bin"
 
 RUN python -m pip install --upgrade pip && \
-    pip install pre-commit
+    pip install black flake8 pre-commit
 
 # enter src directory
 WORKDIR /home/$USER/src

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 127

.github/pre-commit.yml

@@ -0,0 +1,15 @@
+name: Pre-commit checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -16,6 +16,27 @@ repos:
         args: ["--unsafe"]
       - id: check-added-large-files
 
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        types:
+          - python
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+      - id: flake8
+        types:
+          - python
+
+  - repo: https://github.com/pycqa/bandit
+    rev: 1.7.0
+    hooks:
+      - id: bandit
+        args: ["-ll"]
+        files: .py$
+
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.27.1
     hooks:

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "python.linting.flake8Enabled": true,
+    "python.linting.enabled": true,
+    "python.languageServer": "Pylance",
+    "editor.formatOnSave": true,
+    "files.encoding": "utf8",
+    "files.eol": "\n",
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "python.formatting.provider": "black",
+}

docs/.pages

@@ -0,0 +1,3 @@
+nav:
+ - README.md
+ - ...

docs/README.md

@@ -0,0 +1,13 @@
+# Home
+
+This website provides technical documentation for the `eligibility-api` package from the [California Integrated Travel Project (Cal-ITP)](https://www.calitp.org).
+
+Documentation for the `main` (default) branch is available [online](https://docs.calitp.org/eligibility-api).
+
+## Overview
+
+`eligibility-api` is a Python package that encapsulates the data exchange needed to verify one or more eligibility criteria for transit benefits.
+
+The API is designed for privacy and security of user information:
+
+- The API communicates with signed and encrypted JSON Web Tokens containing only the most necessary of user data for the purpose of eligibility verification

docs/getting-started.md

@@ -0,0 +1,35 @@
+# Getting started
+
+The following commands should be run in a terminal program like `bash`.
+
+## Clone the repository
+
+```bash
+git clone https://github.com/cal-itp/eligibility-api.git
+```
+
+## Develop with VS Code Remote Containers
+
+This repository comes with a [VS Code Remote Containers](https://code.visualstudio.com/docs/remote/containers) configuration file.
+
+Once you clone the repository locally, simply open it within VS Code, which will prompt you to re-open the repository within the Remote Container.
+
+## Run and develop the Documentation
+
+When running the [Devcontainer](#develop-with-vs-code-remote-containers), the server is automatically started.
+
+Otherwise, manually start the docs container with
+
+```bash
+docker compose up docs
+```
+
+The site is served from `http://localhost` at a port dynamically assigned by Docker. See
+[Docker dynamic ports][docker-dynamic-ports] for more information.
+
+The website is automatically rebuilt as changes are made to `docs/` files.
+
+Read more on how to run the docs [here][benefits-docs].
+
+[benefits-docs]: https://docs.calitp.org/benefits/getting-started/documentation/
+[docker-dynamic-ports]: https://docs.calitp.org/benefits/getting-started/docker-dynamic-ports