Merge branch 'auto-generated' into develop

.github/workflows/test.yaml

@@ -22,9 +22,8 @@ jobs:
       matrix:
         platform: [ubuntu-latest, macos-latest]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
-
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
@@ -40,32 +39,57 @@ jobs:
     - name: Do Type Checking
       run: tox -e type -vv -s false
 
-    - name: Check for compliance with Python Best Practices
-      run: tox -e check -vv -s false
-
     - name: Specify current package version to assist build tool
       run: echo "PKG_VERSION=$(python scripts/parse_version.py)" >> $GITHUB_ENV
 
     - name: Run Test Suite
       run: tox -vv -s false
       env:
         PLATFORM: ${{ matrix.platform }}
+    - name: Check for compliance with Python Best Practices
+      run: |
+        DIST_DIR=dist
+        echo "DIST_DIR=dist" >> $GITHUB_ENV
 
-    - name: Install coverage.py
-      run: python -m pip install coverage
+        mkdir "$DIST_DIR"
+        mv ".tox/${DIST_DIR}/biskotaki-${PKG_VERSION}.tar.gz" "${DIST_DIR}"
+        mv ".tox/${DIST_DIR}/biskotaki-${PKG_VERSION}-py3-none-any.whl" "${DIST_DIR}"
+        tox -e check -vv -s false
+
+    - name: Upload Source & Wheel distributions as Artefacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: dist-${{ matrix.platform }}-${{ matrix.python-version }}
+        path: ${{ env.DIST_DIR }}
+        if-no-files-found: error
 
     - name: Aggregate Test Suite Coverage Data
       run: |
         python -m pip install coverage
         tox -e coverage --sitepackages -vv -s false
 
-    - name: Upload coverage to Codecov
+    - name: Upload Coverage Data as Artefacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: coverage-xml-data
+        path: ./.tox/coverage.xml
+        if-no-files-found: error
+
+  host_coverage_results:
+    needs: test_suite
+    runs-on: ubuntu-latest
+    steps:
+    - name: Download Coverage Data
+      uses: actions/download-artifact@v2
+      with:
+        name: coverage-xml-data
+    - name: Send Coverage Data to Codecov
       uses: codecov/codecov-action@v2
       with:
-        directory: ./.tox/
+        directory: .
         env_vars: OS,PYTHON
         fail_ci_if_error: true
-        files: ./.tox/coverage.xml
+        files: coverage.xml
         flags: unittests
         name: codecov-umbrella
         verbose: true

.prospector.yml

@@ -10,19 +10,15 @@ ignore-paths:
   - docs
 ignore-patterns:
   - (^|/)skip(this)?(/|$)
-  - tests/test_commands.py
-  - tests/test_mediator.py
-  - tests/test_notification.py
-  - tests/test_phi.py
 autodetect: false
-max-line-length: 120
+max-line-length: 95
 
 
+# TOOLS
+
 pyflakes:
   run: true
-  disable:
-    - F403
-    - F810
+
 
 pyroma:
   run: true
@@ -38,41 +34,26 @@ mccabe:
   options:
     max-complexity: 12
 
+
+# INACTIVE
+
 pylint:
   run: false
 
 bandit:
   run: false
-  options:
-    config: bandit.yml
 
 frosted:
   run: false
-  disable:
-    - E103
-    - E306
 
 pep8:
   run: false
-  disable:
-    - W602
-    - W603
-  enable:
-    - W601
-  options:
-    max-line-length: 79
 
 pep257:
   run: false
-  disable:
-    - D100
-    - D101
 
 mypy:
   run: false
-  options:
-    ignore-missing-imports: true
-    follow-imports: skip
 
 vulture:
   run: false

.readthedocs.yml

@@ -0,0 +1,31 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+  - epub
+
+build:
+  image: latest
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - method: pip
+      path: .[docs]

CHANGELOG.rst

@@ -1,58 +1,9 @@
+=========
 Changelog
 =========
 
-
-0.7.0 (2022-05-11)
-==================
-
-Generate a new `biskotaki` Python Package Project, using the
-`v0.10.0 Cookiecutter Python Package`_ project generator.
-
-The project generation process used the `v.0.10.0 Template`_ and all required input
-information was read from the `v0.10.0 biskotaki.yaml`_ configuration file.
-
-From a developer's point of view, this release's code was produced as follows:
-
-1. Run generator and replace all files in the local `biskotaki` repository checkout
-2. Commit all the changes
-
-For more, on the generator used, check the `documentation`, `repository`_ and `Template`_ links.
-
-Generated Additions
--------------------
-
-Enhance the CI config, by adding extra `checks` in the `Test Jobs` and
-automating the `integration` with the `codecov.io` hosting service.
-
-**Added checks**:
-
-- Doing a 'Lint check' on the code
-- Doing a 'Compliance check' of the resulting packaged distro against python best practices
-- Gathering and sending the Test Suite results to the codecov.io service
-
-**Code Coverage**:
-
-Include `step` in all Test Jobs to gather and send Code Coverage data resulting from running
-the Test Suite.
-
-    `Codecov` is to Code Coverage, as `GA` is to Continuous Integration.
-
-    Upon granting permission, `codecov` will start accepting the accumulated results (such as
-    Code Coverage data) from all `Test Jobs` during a `build` and provide a web UI featuring
-    interactive visualization of the python code and its `coverage` on user-defined granularity
-    level, interactive charts of the `coverage` evolution and more.
-
-Changes
-^^^^^^^
-
-ci
-""
-- enable lint, distro packaging QA & test results transimission to codecov.io CI service
-- enable test workflow for tags matching pattern "v*", pull requests to dev & pushes to ci branch
-
-
-0.0.1 (2022-05-09)
-==================
+0.0.1 (2022-06-06)
+=======================================
 
 | This is the first ever release of the **biskotaki** Python Package.
 | The package is open source and is part of the **Biskotaki** Project.
@@ -75,15 +26,3 @@ ci
 .. LINKS
 
 .. _Cookiecutter Python Package: https://python-package-generator.readthedocs.io/en/master/
-
-.. _Template: https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python
-
-.. _v0.10.0 Template: https://github.com/boromir674/cookiecutter-python-package/tree/v0.10.0/src/cookiecutter_python
-
-.. _v0.10.0 Cookiecutter Python Package: https://python-package-generator.readthedocs.io/en/v0.10.0/
-
-.. _v0.10.0 biskotaki.yaml: https://github.com/boromir674/cookiecutter-python-package/tree/v0.10.0/.github/biskotaki.yaml
-
-.. _documentation: https://python-package-generator.readthedocs.io/
-
-.. _repository: https://github.com/boromir674/cookiecutter-python-package