Use click for CLI, refactor and add docs.

Author: domdfcoding

.bumpversion.cfg

@@ -10,3 +10,5 @@ tag = True
 [bumpversion:file:README.rst]
 
 [bumpversion:file:repo_helper.yml]
+
+[bumpversion:file:doc-source/index.rst]

.github/workflows/cleanup.yml

@@ -0,0 +1,14 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
+---
+name: Artefact Cleaner
+on:
+  schedule:
+  - cron: 0 9 1 * *
+jobs:
+  Clean:
+    runs-on: ubuntu-latest
+    steps:
+    - name: cleanup
+      uses: glassechidna/artifact-cleaner@v2
+      with:
+        minimumAge: 1000000.0

.github/workflows/flake8.yml

@@ -0,0 +1,33 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
+---
+name: Flake8
+
+on:
+  push:
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  Run:
+    name: "Flake8"
+    runs-on: "ubuntu-18.04"
+
+    steps:
+      - name: Checkout 🛎️
+        uses: "actions/checkout@v2"
+
+      - name: Setup Python 🐍
+        uses: "actions/setup-python@v2"
+        with:
+          python-version: "3.8"
+
+      - name: Install dependencies 🔧
+        run: |
+          python -VV
+          python -m site
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install flake8-prettycount
+          python -m pip install .
+
+      - name: "Run Flake8"
+        run: "python -m flake8_prettycount flake8_github_action --format github"

.github/workflows/octocheese.yml

@@ -16,3 +16,4 @@ jobs:
           pypi_name: "notebook2script"
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        if: startsWith(github.ref, 'refs/tags/') != true

.github/workflows/python_ci.yml

@@ -22,17 +22,18 @@ jobs:
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
+
       - name: Setup Python 🐍
         uses: "actions/setup-python@v2"
         with:
           python-version: "${{ matrix.python-version }}"
+
       - name: Install dependencies 🔧
         run: |
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
           python -m pip install --upgrade tox tox-gh-actions virtualenv
 
-
       - name: "Run Tests for Python ${{ matrix.python-version }}"
         run: "python -m tox"

.github/workflows/python_ci_linux.yml

@@ -22,10 +22,12 @@ jobs:
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
+
       - name: Setup Python 🐍
         uses: "actions/setup-python@v2"
         with:
           python-version: "${{ matrix.python-version }}"
+
       - name: Install dependencies 🔧
         run: |
           python -VV
@@ -76,7 +78,7 @@ jobs:
           shopt -s globstar
           python -m coverage combine coverage/**/.coverage
 
-      - name: "Upload Combined Coverage Aretfact"
+      - name: "Upload Combined Coverage Artefact"
         uses: actions/upload-artifact@v2
         with:
           name: "combined-coverage"

.github/workflows/python_ci_macos.yml

@@ -22,17 +22,18 @@ jobs:
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
+
       - name: Setup Python 🐍
         uses: "actions/setup-python@v2"
         with:
           python-version: "${{ matrix.python-version }}"
+
       - name: Install dependencies 🔧
         run: |
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
           python -m pip install --upgrade tox tox-gh-actions virtualenv
 
-
       - name: "Run Tests for Python ${{ matrix.python-version }}"
         run: "python -m tox"

.isort.cfg

@@ -15,21 +15,23 @@ default_section = THIRDPARTY
 ;no_lines_before=LOCALFOLDER
 known_third_party =
     astroid
+    click
+    consolekit
     coverage
-    coverage-pyver-pragma
-    domdf-python-tools
+    coverage_pyver_pragma
+    domdf_python_tools
     github
     ipython
     isort
     nbconvert
-    pre-commit-hooks
+    pre_commit_hooks
     pylint
     pytest
-    pytest-cov
-    pytest-randomly
-    pytest-rerunfailures
-    pytest-timeout
+    pytest_cov
+    pytest_randomly
+    pytest_rerunfailures
+    pytest_timeout
     requests
-    yapf-isort
+    yapf_isort
 known_first_party = notebook2script
 remove_redundant_aliases = True

.pre-commit-config.yaml

@@ -59,13 +59,13 @@ repos:
     - id: forbid-crlf
 
  - repo: https://github.com/domdfcoding/yapf-isort
-   rev: v0.5.2
+   rev: v0.5.4
    hooks:
     - id: yapf-isort
       exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$
 
  - repo: https://github.com/domdfcoding/dep_checker
-   rev: v0.3.1
+   rev: v0.4.1
    hooks:
     - id: dep_checker
       args:

.readthedocs.yml

@@ -1,19 +1,13 @@
 # This file is managed by 'repo_helper'. Don't edit it directly.
 # Read the Docs configuration file
 ---
-
-# Required
 version: 2
-
 sphinx:
   builder: html
   configuration: doc-source/conf.py
-
-# Optionally build your docs in additional formats such as PDF and ePub
 formats: all
-
 python:
   version: 3.8
   install:
-    - requirements: requirements.txt
-    - requirements: doc-source/requirements.txt
+   - requirements: requirements.txt
+   - requirements: doc-source/requirements.txt