Docs

Makefile

@@ -1,41 +1,43 @@
-# -------------------------------------------------------------------------
-# build a package for PyPi
-# -------------------------------------------------------------------------
-.PHONY: build requirements deps-update init
+PYTHON = python3
+PIP = $(PYTHON) -m pip
+.PHONY: pre-commit requirements init clean report build release-test release-prod
 
 pre-commit:
+	pre-commit install
 	pre-commit run --all-files
 
 requirements:
 	pre-commit autoupdate
-	python -m pip install --upgrade pip wheel
+	$(PIP)  install --upgrade pip wheel
 	python -m piptools compile --extra local --upgrade --resolver backtracking -o ./requirements/local.txt pyproject.toml
-	pip install -r requirements/local.txt
+	$(PIP)  -r requirements/local.txt
 
 init:
 	python3.11 -m venv venv && \
-	source venv/bin/activate && \
+	. venv/bin/activate && \
 	rm -rf .tox && \
-	python -m pip install --upgrade pip wheel && \
-	python -m pip install --upgrade -r requirements/local.txt -e . && \
-	python -m pip check
+	$(PIP) install  --upgrade pip wheel && \
+	$(PIP) install  --upgrade -r requirements/local.txt -e . && \
+	python -m pip check && \
+	npm install
+
+clean:
+	rm -rf build dist secure_logger.egg-info
 
 report:
-	cloc $(git ls-files)
+	cloc . --exclude-ext=svg,json,zip --vcs=git
 
 
 build:
-	python3 -m pip install --upgrade setuptools wheel twine
-	python -m pip install --upgrade build
+	$(PIP) install  --upgrade setuptools wheel twine
+	$(PIP) install  --upgrade build
 
-	if [ -d "./build" ]; then sudo rm -r build; fi
-	if [ -d "./dist" ]; then sudo rm -r dist; fi
-	if [ -d "./secure_logger.egg-info" ]; then sudo rm -r secure_logger.egg-info; fi
+	make clean
 
-	python3 -m build --sdist ./
-	python3 -m build --wheel ./
+	$(PYTHON) -m build --sdist ./
+	$(PYTHON) -m build --wheel ./
 
-	python3 -m pip install --upgrade twine
+	$(PYTHON) -m pip install --upgrade twine
 	twine check dist/*
 
 

SECURITY.md

@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest version of this project is currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| latest  | :white_check_mark: |
+| < latest| :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within this project, please send an email to [lpm0073@gmail.com](mailto:lpm0073@gmail.com). All security vulnerabilities will be promptly addressed.
+
+Please do not publicly disclose the issue until it has been addressed by the team.
+
+### Process
+
+1. The vulnerability will be acknowledged within 48 hours of receipt
+2. The team will investigate the issue and provide an estimated time for a fix
+3. Once a fix is prepared, it will be tested and confirmed
+4. The fix will be released as a new version of the package on PyPi
+5. The vulnerability report will be publicly disclosed, acknowledging the finder