[MERGE]

* feature-add-docs:
  [STYLE] Style fixes (- WIP PR #76 -)
  [REGRESSION] Revert flake8.ini filename (- WIP PR #76 -)
  [CONFIG] minor fix for flake8 config
  [PATCH] Minor updates from review (- WIP PR #76 -)
  Update conf.py imports
  Update toc.md headers
  Update README.md headers
  [DOCUMENTATION] debugged sphinx build feature
  [DOCUMENTATION] tweaks to sphinx build html by default
  [CONFIG] tweaks to sphinx config
  [FEATURE] Prototype for docs via sphinx

* dependabot/github_actions/dot-github/workflows/master/codecov/codecov-action-5:
  [UPDATE] (deps): Bump codecov/codecov-action in /.github/workflows

Author: reactive-firewall

.github/SECURITY.md

@@ -0,0 +1,41 @@
+# Security Policy (Template)
+
+## Supported Versions
+
+We actively support the following versions of the project:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, we encourage you to report it as soon as possible. Please email us at [[email protected]](mailto:[email protected]) with a detailed description of the issue and any relevant proof of concept. We are committed to addressing all security concerns promptly.
+
+## Security Measures
+
+- **Dependency Management**: Our project uses `requirements.txt` and `setup.py` for dependency management. We regularly review and update dependencies to patch known vulnerabilities, adhering to best practices in dependency hygiene.
+
+- **Handling of Secrets**: The codebase does not contain hardcoded secrets such as passwords, API keys, or tokens. We recommend that all contributors use environment variables or secure configuration management tools to handle sensitive information.
+
+- **Secure Coding Practices**: We follow custom coding standards, including **CEP-8** for Python and **CEP-5** for Bash scripts, to ensure code quality and security. These standards emphasize input validation, error handling, and adherence to the principle of least privilege.
+
+- **Encryption and Cryptography**: While the current codebase does not implement encryption or decryption functionalities, any future cryptographic implementations will utilize well-vetted libraries and follow industry-standard algorithms to ensure data integrity and confidentiality.
+
+- **Authentication and Authorization**: References to authentication mechanisms are minimal. Any future integration of authentication features will be designed with robust security protocols and regular audits.
+
+## Code Scanning and Continuous Integration
+
+We employ tools such as `flake8`, `pytest`, and `tox` for continuous integration and static code analysis. These tools help us identify potential security issues early in the development process.
+
+## Security Updates
+
+We are committed to promptly updating the project to address any security vulnerabilities. Users are encouraged to keep their versions up to date to benefit from the latest security enhancements.
+
+## Third-Party Dependencies
+
+All third-party libraries and dependencies are sourced from trusted repositories. We closely monitor these dependencies for any reported vulnerabilities and apply patches as necessary.
+
+## Contact Information
+
+For any security-related inquiries or to report a vulnerability, please contact us at [[email protected]](mailto:[email protected]).

.github/workflows/Tests.yml

@@ -221,7 +221,7 @@ jobs:
       if: ${{ runner.python-version }} != "3.9"
       run: make -f Makefile test-pytest ;
     - name: Upload Python ${{ matrix.python-version }} coverage to Codecov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./coverage.xml
@@ -300,7 +300,7 @@ jobs:
       if: ${{ runner.python-version }} != "3.9"
       run: make -f Makefile test-pytest ;
     - name: Upload Python ${{ matrix.python-version }} coverage to Codecov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./coverage.xml
@@ -414,7 +414,7 @@ jobs:
         cp -vf ./coverage.xml ./test-reports/coverage.xml || true ;
       shell: bash
     - name: Upload Python ${{ matrix.python-version }} coverage to Codecov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./test-reports/coverage_supplement.xml