♻️ REFACTOR: package API/CLI/documentation (#74)

This commit re-writes key parts of the package,
(a) to add additional functionality,
and (b) with a view to eventually exposing this CLI in https://jupyterbook.org/.

Key changes:

1. `stage`/`staging` is now rephrased to `notebook`, plus the addition of `project`, i.e. you add notebooks to a project, then execute them
2. notebook `read_data` is specified per notebook in the project, allowing for multiple types of file to be read/executed via the CLI (e.g. MyST Markdown files, via https://jupytext.readthedocs.io). 
  Before, the read functions were passed directly to the API methods.
3. The executor can be specified with `jbcache execute --executor`, and a parallel notebook executor has been added.
4. Improved execution status indicator in `jbcache project list` and other CLI improvements
4. Re-write of documentation, including better front page, with quick start guide and better logo.

Author: chrisjsewell

.github/workflows/tests.yml

@@ -18,18 +18,18 @@ jobs:
     - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
-        python-version: 3.8
+        python-version: "3.8"
     - uses: pre-commit/[email protected]
 
   tests:
 
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
         include:
           - os: windows-latest
-            python-version: 3.7
+            python-version: "3.8"
 
     runs-on: ${{ matrix.os }}
 
@@ -67,14 +67,14 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v2
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v1
         with:
-          python-version: 3.7
+          python-version: "3.8"
       - name: Build package
         run: |
-          pip install wheel
-          python setup.py sdist bdist_wheel
+          pip install build
+          python -m build
       - name: Publish
         uses: pypa/[email protected]
         with:

.gitignore

@@ -133,3 +133,6 @@ _archive/
 *_old*
 .DS_Store
 .vscode/
+~$*
+_*.ipynb
+final_notebook.ipynb

.pre-commit-config.yaml

@@ -8,8 +8,8 @@ exclude: >
 
 repos:
 
-  - repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
     hooks:
     - id: check-json
     - id: check-yaml
@@ -23,13 +23,19 @@ repos:
       args: [--no-build-isolation]
       additional_dependencies: [setuptools>=46.4.0]
 
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.0
+    hooks:
+    - id: pyupgrade
+      args: [--py37-plus]
+
   - repo: https://github.com/pycqa/isort
-    rev: 5.9.3
+    rev: 5.10.1
     hooks:
     - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 21.9b0
+    rev: 21.12b0
     hooks:
     - id: black
 

.readthedocs.yml

@@ -6,6 +6,7 @@ python:
       - method: pip
         path: .
         extra_requirements:
+          - cli
           - rtd
 
 sphinx: