Refactor: simplify scripts (#119)

* simplify CLI
* drop CI/pep8
* fix vars
* bash render
* bash generate
* bash test
* prune

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: Borda

.actions/assistant.py

@@ -90,15 +90,17 @@ jobs:
 
     - bash: |
         while IFS= read -r line; do
-            bash .actions/ipynb-generate.sh $line
+            python .actions/assistant.py augment-script $line
         done <<< $(cat changed-folders.txt)
       condition: gt(variables['changed.folders'], 0)
       displayName: 'Generate notebook'
 
     - bash: |
         # render the actual notebooks
         while IFS= read -r line; do
-            bash .actions/ipynb-render.sh $line
+            python .actions/assistant.py bash-render $line > .actions/_ipynb-render.sh
+            cat .actions/_ipynb-render.sh
+            bash .actions/_ipynb-render.sh
         done <<< $(cat changed-folders.txt)
         git status
         git commit -m "publish [GPU]: $(COMMIT_HASH)"

.actions/ipynb-generate.sh

@@ -72,14 +72,16 @@ jobs:
 
     - bash: |
         while IFS= read -r line; do
-            bash .actions/ipynb-generate.sh $line
+            python .actions/assistant.py augment-script $line
         done <<< $(cat changed-folders.txt)
       condition: gt(variables['changed.folders'], 0)
       displayName: 'Generate notebook'
 
     - bash: |
         while IFS= read -r line; do
-            bash .actions/ipynb-test.sh $line
+            python .actions/assistant.py bash-test $line > .actions/_ipynb-test.sh
+            cat .actions/_ipynb-test.sh
+            bash .actions/_ipynb-test.sh
         done <<< $(cat changed-folders.txt)
       condition: and(succeeded(), gt(variables['changed.folders'], 0))
       displayName: 'PyTest notebook'

.actions/ipynb-render.sh

@@ -10,20 +10,6 @@ on:  # Trigger the workflow on push or pull request, but only for the main branc
   pull_request: {}
 
 jobs:
-  pep8-check-flake8:
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@master
-      - uses: actions/setup-python@v2
-        with:
-          python-version: 3.7
-      - name: Install dependencies
-        run: pip install flake8 && pip list
-        shell: bash
-      - name: PEP8
-        run: |
-          flake8 .
-
   pre-commit-check:
     runs-on: ubuntu-latest
     steps:

.actions/ipynb-test.sh

@@ -60,8 +60,10 @@ jobs:
         if: steps.changed.outputs.dirs != 0
         run: |
           while IFS= read -r line; do
-              bash .actions/ipynb-generate.sh $line
-              bash .actions/ipynb-render.sh $line
+              python .actions/assistant.py augment-script $line
+              python .actions/assistant.py bash-render $line > .actions/_ipynb-render.sh
+              cat .actions/_ipynb-render.sh
+              bash .actions/_ipynb-render.sh
           done <<< $(cat changed-folders.txt)
         env:
           DRY_RUN: 1

.azure-pipelines/ipynb-publish.yml

@@ -70,14 +70,16 @@ jobs:
         if: steps.changed.outputs.dirs != 0
         run: |
           while IFS= read -r line; do
-              bash .actions/ipynb-generate.sh $line
+              python .actions/assistant.py augment-script $line
           done <<< $(cat changed-folders.txt)
         shell: bash
 
       - name: PyTest notebook
         if: success() && steps.changed.outputs.dirs != 0
         run: |
           while IFS= read -r line; do
-              bash .actions/ipynb-test.sh $line
+              python .actions/assistant.py bash-test $line > .actions/_ipynb-test.sh
+              cat .actions/_ipynb-test.sh
+              bash .actions/_ipynb-test.sh
           done <<< $(cat changed-folders.txt)
         shell: bash

.azure-pipelines/ipynb-tests.yml

@@ -60,7 +60,7 @@ repos:
           - mdformat-black
           - mdformat_frontmatter
 
-#  - repo: https://github.com/PyCQA/flake8
-#    rev: 3.9.2
-#    hooks:
-#      - id: flake8
+  - repo: https://github.com/PyCQA/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8

.github/workflows/ci_code-format.yml

@@ -15,8 +15,9 @@ ipynb: init ${IPYNB}
 
 %.ipynb: %/.meta.y*ml
 	@echo $<
-	bash .actions/ipynb-generate.sh $(shell dirname $<)
-	bash .actions/ipynb-render.sh $(shell dirname $<)
+	python .actions/assistant.py augment-script $(shell dirname $<)
+	python .actions/assistant.py bash-render $(shell dirname $<) > .actions/_ipynb-render.sh
+	bash .actions/_ipynb-render.sh
 
 docs: clean
 	pip install --quiet -r docs/requirements.txt

.github/workflows/ci_docs.yml

@@ -20,7 +20,7 @@
 sys.path.insert(0, os.path.abspath(_PATH_ROOT))
 sys.path.append(os.path.join(_PATH_ROOT, ".actions"))
 
-from helpers import HelperCLI  # noqa: E402
+from assistant import AssistantCLI  # noqa: E402
 
 # -- Project information -----------------------------------------------------
 
@@ -42,7 +42,7 @@
 
 # -- Project documents -------------------------------------------------------
 
-HelperCLI.copy_notebooks(_PATH_ROOT, _PATH_HERE)
+AssistantCLI.copy_notebooks(_PATH_ROOT, _PATH_HERE)
 
 # with open(os.path.join(_PATH_HERE, 'ipynb_content.rst'), 'w') as fp:
 #     fp.write(os.linesep.join(ipynb_content))

.github/workflows/ci_testing.yml

@@ -3,7 +3,7 @@ author: PL team
 created: 2021-06-15
 updated: 2021-06-17
 license: CC
-build: 5
+build: 6
 description: |
   This is a template to show how to contribute a tutorial.
 requirements: