Merge pull request #51 from FullStackWithLawrence/next

v0.2.0

.github/CONTRIBUTING.md

@@ -1,2 +1,3 @@
 # Contributing
+
 The repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE license, and follows a standard Github development process, using Github tracker for issues and merging pull requests into master.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,7 +1,6 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-
 ---
 
 **Describe the bug**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,6 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,19 @@
 ### Type of Change
+
 <!-- What type of change does your code introduce? -->
+
 - [ ] New feature
 - [ ] Bug fix
 - [ ] Documentation
 - [ ] Refactor
 - [ ] Chore
 
 ### Resolves
+
 - Fixes #[Add issue number here.]
 
 ### Describe Changes
+
 <!-- Describe your changes in detail, if applicable. -->
+
 _Describe what this Pull Request does_

.github/actions/tests/python/action.yml

@@ -12,7 +12,6 @@ inputs:
     required: true
     type: string
 
-
 env:
   REQUIREMENTS_PATH: "requirements/local.txt"
 

.github/workflows/auto-assign.yml

@@ -11,9 +11,9 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-    - name: 'Auto-assign issue'
-      uses: pozil/auto-assign-issue@v1
-      with:
+      - name: "Auto-assign issue"
+        uses: pozil/auto-assign-issue@v1
+        with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           assignees: lpm0073
           numOfAssignee: 1

.github/workflows/semanticVersionBump.yml

@@ -110,6 +110,8 @@ jobs:
         id: update_version
         run: |
           echo "# -*- coding: utf-8 -*-" > ${{ env.VERSION_FILE }}
+          echo "# DO NOT EDIT." > ${{ env.VERSION_FILE }}
+          echo "# Managed via automated CI/CD in .github/workflows/semanticVersionBump.yml." > ${{ env.VERSION_FILE }}
           echo "__version__ = \"${{ env.NEXT_VERSION }}\"" >>  ${{ env.VERSION_FILE }}
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"

.gitignore

@@ -1,3 +1,10 @@
+# Build artifacts
+build/
+dist/
+*.egg-info/
+*.egg
+
+
 # Jupyter Notebook
 .ipynb_checkpoints
 data

.mergify.yml

@@ -3,16 +3,16 @@
 pull_request_rules:
   - name: automatic approve dependabot pull requests
     conditions:
-      - 'author~=dependabot[bot]|dependabot-preview[bot]|dependabot'
+      - "author~=dependabot[bot]|dependabot-preview[bot]|dependabot"
     actions:
       review:
         type: APPROVE
 
   - name: automatic merge dependabot pull requests
     conditions:
-      - 'author~=dependabot[bot]|dependabot-preview[bot]|dependabot'
-      - '#approved-reviews-by>=1'
-      - 'base=main'  # replace 'main' with the name of the branch you want to auto-merge into
+      - "author~=dependabot[bot]|dependabot-preview[bot]|dependabot"
+      - "#approved-reviews-by>=1"
+      - "base=main" # replace 'main' with the name of the branch you want to auto-merge into
     actions:
       merge:
         method: merge

.pre-commit-config.yaml

@@ -2,6 +2,10 @@ default_language_version:
   # default language version for each language
   python: python3.11
 repos:
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.3-1
+    hooks:
+      - id: prettier
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6
     hooks:

.pylintrc

@@ -8,4 +8,4 @@ ignore =
 max-line-length=120
 
 [MESSAGES CONTROL]
-disable=C0103,W0102,E0401
+disable=too-few-public-methods,invalid-name

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
-    "cornflakes.linter.executablePath": "./venv/bin/flake8",
-    "[yaml]": {
-        "editor.autoIndent": "none"
-    }
+  "cornflakes.linter.executablePath": "./venv/bin/flake8",
+  "[yaml]": {
+    "editor.autoIndent": "none"
+  }
 }

CHANGELOG.md

@@ -1,101 +1,122 @@
-## [0.1.18](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.17...v0.1.18) (2023-12-05)
+# Change Log
+
+## 0.2.0 Draft Release Notes
+
+The primary objective of this release is to make the package configurable at run-time using standard environment variables and/or a .env file. While adding this feature we also took the step of creating a config.Settings class with significant data validation capability, mostly thanks to Pydantic.
+
+Secondarily, we took steps to make this project conform to [12-factor methodology](./doc/Twelve_Factor_Methodology.md). We want to make this project more accessible to students and learners as an instructional tool while not adding undue code review workloads to anyone with merge authority for this project. To this end we've added several pre-commit code linting and code style tools as well as a quasi-standardized set of GitHub Actions CI/CD automations that manage pull requests and semantic releases.
+
+### Commit and Release Details
+
+- Add a [config.Settings](./secure_logger/conf.py) class with Pydantic validations and ability to configure at run-time via bash environment variable and/or a .env file.
+- Add [SecureLoggerConfigurationError](./secure_logger/exceptions.py) exception class to raise exception in the event of any Pydantic and/or package data validation errors during configuration.
+- add [log_level](./secure_logger/decorators.py) input parameter to decorator to allow customization of the log level on individual log entries.
+- Refactored [setup.py](./setup.py) to remove deprecated macOS functions.
+- Add a [security policy](./SECURITY.md)
+- Add a [contributor policy](.github/CONTRIBUTING.md)
+- Added README badges to report live status of unit tests and CI/CD. Converted README to markdown.
+- Add [Dependabot](.github/dependabot.yml) and [Mergify](./.mergify.yml) to periodically monitor and update PyPi and NPM requirements
+- Add [pre-commit](./.pre-commit-config.yml) with codespell, black, flake8, isort, pylint, bandit, tox, prettier. Add built-in pre-commit hooks for code style and security.
+- Added the following Github Actions:
+  - Automated unit testing on push
+  - Auto-assign new Issues
+  - Periodic automated patch releases after Dependabot runs
+  - Pull request automation
+  - Semantic release
+  - Automated merge of main to dev branches
+- Add GitHub templates for [Issue](./.github/ISSUE_TEMPLATE/), [Contributing](./.github/CONTRIBUTING.md), [Funding](./.github/FUNDING.yml), [Pull Request](./.github/PULL_REQUEST_TEMPLATE.md)
+- Add the following to the [Makefile](./Makefile)
+  - Recognition of .env file
+  - Scaffold multi platform support
+  - Make lint
+  - Make help
 
+## [0.1.18](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.17...v0.1.18) (2023-12-05)
 
 ### Bug Fixes
 
-* add missing actions ([d2ea137](https://github.com/FullStackWithLawrence/secure-logger/commit/d2ea1376034fcd33b47a53da9cb15ad893448314))
+- add missing actions ([d2ea137](https://github.com/FullStackWithLawrence/secure-logger/commit/d2ea1376034fcd33b47a53da9cb15ad893448314))
 
 ## [0.1.17](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.16...v0.1.17) (2023-11-14)
 
-
 ### Bug Fixes
 
-* add regex expressions to correctly evaluate all possible values of __version__.py ([1ac6246](https://github.com/FullStackWithLawrence/secure-logger/commit/1ac6246f4840457a62d6a7a6ccf03065c28643c7))
-* restore npx semantic-release logic in next branch ([e8e4b1d](https://github.com/FullStackWithLawrence/secure-logger/commit/e8e4b1db87d3e04e8e263080ca8adc4fda989d86))
+- add regex expressions to correctly evaluate all possible values of **version**.py ([1ac6246](https://github.com/FullStackWithLawrence/secure-logger/commit/1ac6246f4840457a62d6a7a6ccf03065c28643c7))
+- restore npx semantic-release logic in next branch ([e8e4b1d](https://github.com/FullStackWithLawrence/secure-logger/commit/e8e4b1db87d3e04e8e263080ca8adc4fda989d86))
 
 ## [0.1.16](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.15...v0.1.16) (2023-11-14)
 
-
 ### Bug Fixes
 
-* convert prerelease version to strict semantic equivalent ([f463db5](https://github.com/FullStackWithLawrence/secure-logger/commit/f463db5d53499166968fe0d9a36a36e3327d36d4))
-* remove pre-commit ([12c3da0](https://github.com/FullStackWithLawrence/secure-logger/commit/12c3da0042cd7ff03783c278fddf1c3bb6b4f69a))
-* set prerelease to true for next and nexst-major ([b830102](https://github.com/FullStackWithLawrence/secure-logger/commit/b8301020b57a5e1bc09517100d3d2724e9c7d716))
+- convert prerelease version to strict semantic equivalent ([f463db5](https://github.com/FullStackWithLawrence/secure-logger/commit/f463db5d53499166968fe0d9a36a36e3327d36d4))
+- remove pre-commit ([12c3da0](https://github.com/FullStackWithLawrence/secure-logger/commit/12c3da0042cd7ff03783c278fddf1c3bb6b4f69a))
+- set prerelease to true for next and nexst-major ([b830102](https://github.com/FullStackWithLawrence/secure-logger/commit/b8301020b57a5e1bc09517100d3d2724e9c7d716))
 
 ## [0.1.15](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.14...v0.1.15) (2023-11-14)
 
-
 ### Bug Fixes
 
-* add npx semantic-release --dry-run --no-ci ([d0133ab](https://github.com/FullStackWithLawrence/secure-logger/commit/d0133ab6d966370b5eabf44e3543c81d3fe6b850))
+- add npx semantic-release --dry-run --no-ci ([d0133ab](https://github.com/FullStackWithLawrence/secure-logger/commit/d0133ab6d966370b5eabf44e3543c81d3fe6b850))
 
 ## [0.1.14](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.13...v0.1.14) (2023-11-14)
 
-
 ### Bug Fixes
 
-* fix requirements path for semantic release ([f2ad049](https://github.com/FullStackWithLawrence/secure-logger/commit/f2ad049e7a146a3eadc75606db87651c0e89e59a))
-* must add next and next-major ([7434ecf](https://github.com/FullStackWithLawrence/secure-logger/commit/7434ecfc7e82cf3c6c9b2e771ea410883a722343))
+- fix requirements path for semantic release ([f2ad049](https://github.com/FullStackWithLawrence/secure-logger/commit/f2ad049e7a146a3eadc75606db87651c0e89e59a))
+- must add next and next-major ([7434ecf](https://github.com/FullStackWithLawrence/secure-logger/commit/7434ecfc7e82cf3c6c9b2e771ea410883a722343))
 
 ## [0.1.13](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.12...v0.1.13) (2023-11-14)
 
-
 ### Bug Fixes
 
-* long_description_content_type='text/x-rst' ([d551597](https://github.com/FullStackWithLawrence/secure-logger/commit/d551597c208b3de6d635947ae2247c755928816e))
+- long_description_content_type='text/x-rst' ([d551597](https://github.com/FullStackWithLawrence/secure-logger/commit/d551597c208b3de6d635947ae2247c755928816e))
 
 ## [0.1.12](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.11...v0.1.12) (2023-11-14)
 
-
 ### Bug Fixes
 
-* refactor python code blocks using readme_renderer compliant directives ([49a3423](https://github.com/FullStackWithLawrence/secure-logger/commit/49a34234bb95ed37676f0620eb481a221302b73a))
+- refactor python code blocks using readme_renderer compliant directives ([49a3423](https://github.com/FullStackWithLawrence/secure-logger/commit/49a34234bb95ed37676f0620eb481a221302b73a))
 
 ## [0.1.11](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.10...v0.1.11) (2023-11-14)
 
-
 ### Bug Fixes
 
-* CURRENT_VERSION was unassigned ([528fa71](https://github.com/FullStackWithLawrence/secure-logger/commit/528fa71dc0fc008bd7098686cab94198a961f5c3))
+- CURRENT_VERSION was unassigned ([528fa71](https://github.com/FullStackWithLawrence/secure-logger/commit/528fa71dc0fc008bd7098686cab94198a961f5c3))
 
 ## [0.1.10](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.9...v0.1.10) (2023-11-14)
 
-
 ### Bug Fixes
 
-* add a dedicated version bump workflow ([8c59680](https://github.com/FullStackWithLawrence/secure-logger/commit/8c596807fda14a7d1ec927267d68db776ef1d822))
-* need to git pull ([24f177d](https://github.com/FullStackWithLawrence/secure-logger/commit/24f177da2ef4b70ba73c69b9c1c51133a6d29c3c))
-* need to git pull ([2e60dbb](https://github.com/FullStackWithLawrence/secure-logger/commit/2e60dbbd5922649e0dc5b0177f145d49f7b476dd))
-* need to git pull ([e173922](https://github.com/FullStackWithLawrence/secure-logger/commit/e173922d290eba66addda88f408aa0d576382214))
-* remove version bump ([7b71ae9](https://github.com/FullStackWithLawrence/secure-logger/commit/7b71ae9c484486cd124b751bc201f16cc2d627bf))
+- add a dedicated version bump workflow ([8c59680](https://github.com/FullStackWithLawrence/secure-logger/commit/8c596807fda14a7d1ec927267d68db776ef1d822))
+- need to git pull ([24f177d](https://github.com/FullStackWithLawrence/secure-logger/commit/24f177da2ef4b70ba73c69b9c1c51133a6d29c3c))
+- need to git pull ([2e60dbb](https://github.com/FullStackWithLawrence/secure-logger/commit/2e60dbbd5922649e0dc5b0177f145d49f7b476dd))
+- need to git pull ([e173922](https://github.com/FullStackWithLawrence/secure-logger/commit/e173922d290eba66addda88f408aa0d576382214))
+- remove version bump ([7b71ae9](https://github.com/FullStackWithLawrence/secure-logger/commit/7b71ae9c484486cd124b751bc201f16cc2d627bf))
 
 ## [0.1.9](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.8...v0.1.9) (2023-11-13)
 
-
 ### Bug Fixes
 
-* have to skip CI automated unit tests when commit __version__.py ([0e939c8](https://github.com/FullStackWithLawrence/secure-logger/commit/0e939c87eb3ab0aafe6475691f1380127ea1860b))
-* refactor call to npx semantic-release ([2c7d768](https://github.com/FullStackWithLawrence/secure-logger/commit/2c7d768c8875a11f68ff47700e4c8a107a98c89b))
+- have to skip CI automated unit tests when commit **version**.py ([0e939c8](https://github.com/FullStackWithLawrence/secure-logger/commit/0e939c87eb3ab0aafe6475691f1380127ea1860b))
+- refactor call to npx semantic-release ([2c7d768](https://github.com/FullStackWithLawrence/secure-logger/commit/2c7d768c8875a11f68ff47700e4c8a107a98c89b))
 
 ## [0.1.8](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.7...v0.1.8) (2023-11-13)
 
-
 ### Bug Fixes
 
-* required upgrade to node 20.9.0 ([756ea63](https://github.com/FullStackWithLawrence/secure-logger/commit/756ea6366bfe828783be17f4d581e8b4cd7f6574))
-* required upgrade to node 20.9.0 ([9bc8871](https://github.com/FullStackWithLawrence/secure-logger/commit/9bc88718b3ffbfdd002d9156dcbad3db974b723f))
+- required upgrade to node 20.9.0 ([756ea63](https://github.com/FullStackWithLawrence/secure-logger/commit/756ea6366bfe828783be17f4d581e8b4cd7f6574))
+- required upgrade to node 20.9.0 ([9bc8871](https://github.com/FullStackWithLawrence/secure-logger/commit/9bc88718b3ffbfdd002d9156dcbad3db974b723f))
 
 ## [0.1.7](https://github.com/FullStackWithLawrence/secure-logger/compare/v0.1.6...v0.1.7) (2023-11-13)
 
-
 ### Bug Fixes
 
-* add missing package descriptors ([72bc5b3](https://github.com/FullStackWithLawrence/secure-logger/commit/72bc5b3c296e3f5d809ecad894c8b25aa1e0e0fa))
-* correct path to python requirements ([cdc0557](https://github.com/FullStackWithLawrence/secure-logger/commit/cdc05577f5b6e5c1bb46b141ff61ff00a0eca899))
-* fix calls to unit tests ([9b98d18](https://github.com/FullStackWithLawrence/secure-logger/commit/9b98d18016cfe99b38298bd910831c1de3988db0))
-* fix path to secure_logger ([1d6a1d9](https://github.com/FullStackWithLawrence/secure-logger/commit/1d6a1d90c233464746a85dcb0add3ba6e0f8297a))
-* move __version__.py to the root ([da0beac](https://github.com/FullStackWithLawrence/secure-logger/commit/da0beac04ec3144936aa92fb5deca8b97945b439))
-* remove reference to django migrations ([e0a62be](https://github.com/FullStackWithLawrence/secure-logger/commit/e0a62be13deb323f683d39134f42b203e413ff49))
+- add missing package descriptors ([72bc5b3](https://github.com/FullStackWithLawrence/secure-logger/commit/72bc5b3c296e3f5d809ecad894c8b25aa1e0e0fa))
+- correct path to python requirements ([cdc0557](https://github.com/FullStackWithLawrence/secure-logger/commit/cdc05577f5b6e5c1bb46b141ff61ff00a0eca899))
+- fix calls to unit tests ([9b98d18](https://github.com/FullStackWithLawrence/secure-logger/commit/9b98d18016cfe99b38298bd910831c1de3988db0))
+- fix path to secure_logger ([1d6a1d9](https://github.com/FullStackWithLawrence/secure-logger/commit/1d6a1d90c233464746a85dcb0add3ba6e0f8297a))
+- move **version**.py to the root ([da0beac](https://github.com/FullStackWithLawrence/secure-logger/commit/da0beac04ec3144936aa92fb5deca8b97945b439))
+- remove reference to django migrations ([e0a62be](https://github.com/FullStackWithLawrence/secure-logger/commit/e0a62be13deb323f683d39134f42b203e413ff49))
 
 # CHANGE LOG
 

CODE_OF_CONDUCT.md

@@ -2,11 +2,11 @@
 
 ## 1. Purpose
 
-A primary goal of aws_openai is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+A primary goal of secure_logger is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
 
 This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
 
-We invite all those who participate in aws_openai to help us create safe and positive experiences for everyone.
+We invite all those who participate in secure_logger to help us create safe and positive experiences for everyone.
 
 ## 2. Open Source Citizenship
 
@@ -39,7 +39,7 @@ The following behaviors are considered harassment and are unacceptable within ou
 
 ## 5. Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [FullStackWithLawrence@gmail.com](mailto:FullStackWithLawrence@gmail.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [lpm0073@gmail.com](mailto:lpm0073@gmail.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.