Merge pull request #11 from lpm0073/next

fix: move __version__.py to the root

Author: lpm0073

.github/workflows/tests.yml

@@ -10,14 +10,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/[email protected]
+        uses: actions/checkout@v4
+
       - name: Set up Python 3.x
         uses: actions/setup-python@v4
         with:
-          python-version: "3.8"
+          python-version: "3.11"
+
       - name: Install requirements
-        run: python -m pip install -r requirements/local.txt
-      - name: Lint
-        run: pre-commit run --all-files
-      - name: Unit tests
-        run: python -m tests
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ./requirements/local.txt
+
+      - name: secure_logger Unit tests
+        run: |
+          export PYTHONPATH=$PYTHONPATH:$(pwd)
+          python -m unittest discover -s secure_logger/tests/
+
+      - name: setup.py tests
+        run: |
+          export PYTHONPATH=$PYTHONPATH:$(pwd)
+          python -m unittest setup_test

.gitignore

@@ -1,4 +1,5 @@
 .env
+venv
 # .gitignore for edx-platform.
 # There's a lot here, please try to keep it organized.
 
@@ -12,6 +13,7 @@ requirements/private.txt
 
 ### Python artifacts
 *.pyc
+__pycache__/
 
 ### Editor and IDE artifacts
 *~

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 default_language_version:
   # default language version for each language
-  python: python3.8
+  python: python3.11
 repos:
   -   repo: https://github.com/ambv/black
       rev: 23.3.0

Makefile

@@ -1,7 +1,7 @@
 # -------------------------------------------------------------------------
 # build a package for PyPi
 # -------------------------------------------------------------------------
-.PHONY: build requirements deps-update deps-init
+.PHONY: build requirements deps-update init
 
 pre-commit:
 	pre-commit run --all-files
@@ -12,10 +12,12 @@ requirements:
 	python -m piptools compile --extra local --upgrade --resolver backtracking -o ./requirements/local.txt pyproject.toml
 	pip install -r requirements/local.txt
 
-deps-init:
-	rm -rf .tox
-	python -m pip install --upgrade pip wheel
-	python -m pip install --upgrade -r requirements/local.txt -e .
+init:
+	python3.11 -m venv venv && \
+	source 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
 
 report:

README.md

@@ -123,7 +123,7 @@ Pull requests are welcome, and you can also contact [Lawrence McDaniel](https://
 ### Getting Started With Local development
 
 - Use the same virtual environment that you use for edx-platform
-- Ensure that your Python interpreter to 3.8x
+- Ensure that your Python interpreter to 3.11
 - install black: <https://pypi.org/project/black/>
 - install flake8: <https://flake8.pycqa.org/en/latest/>
 - install flake8-coding: <https://pypi.org/project/flake8-coding/>

secure_logger/__version__.py renamed to __version__.py

@@ -25,10 +25,12 @@ build-backend = "setuptools.build_meta:__legacy__"
 [project]
 name = "secure-logger"
 version = "0.1.6"
+license = { file = "LICENSE.txt" }
 authors = [
   { name="Lawrence McDaniel", email="[email protected]" }
 ]
 description = "A decorator to generate secure, well-formatted log entries"
+dynamic = ["maintainers"]
 readme = "README.md"
 requires-python = ">=3.6"
 classifiers = [

pyproject.toml

@@ -1,53 +1,3 @@
-#
-# This file is autogenerated by pip-compile with Python 3.8
-# by the following command:
-#
-#    pip-compile --extra=local --output-file=./requirements/local.txt --resolver=backtracking pyproject.toml
-#
-
-# dev dependencies
 black==23.3.0
-    # via secure-logger (pyproject.toml)
-cfgv==3.3.1
-    # via pre-commit
-click==8.1.3
-    # via black
-distlib==0.3.6
-    # via virtualenv
-filelock==3.12.0
-    # via virtualenv
 flake8==6.0.0
-    # via secure-logger (pyproject.toml)
-identify==2.5.23
-    # via pre-commit
-mccabe==0.7.0
-    # via flake8
-mypy-extensions==1.0.0
-    # via black
-nodeenv==1.7.0
-    # via pre-commit
-packaging==23.1
-    # via black
-pathspec==0.11.1
-    # via black
-platformdirs==3.4.0
-    # via
-    #   black
-    #   virtualenv
 pre-commit==3.2.2
-    # via secure-logger (pyproject.toml)
-pycodestyle==2.10.0
-    # via flake8
-pyflakes==3.0.1
-    # via flake8
-pyyaml==6.0
-    # via pre-commit
-tomli==2.0.1
-    # via black
-typing-extensions==4.5.0
-    # via black
-virtualenv==20.22.0
-    # via pre-commit
-
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools

requirements/local.txt

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+"""This is the initialization file for the Python package tests."""

secure_logger/tests/__init__.py

@@ -96,7 +96,7 @@ def test_decorator_output(self):
         hello_world = "'hello world'"
 
         expected_output = (
-            "INFO:secure_logger.decorators:secure_logger: __main__.mock_decorated_def() ['<__main__.TestModuleDefDecorator testMethod=test_decorator_output>', "
+            "INFO:secure_logger.decorators:secure_logger: tests.mock_decorated_def() ['<tests.TestModuleDefDecorator testMethod=test_decorator_output>', "
             + hello_world
         )
         with self.assertLogs(level=logging.DEBUG) as cm:
@@ -128,7 +128,7 @@ def decorator_with_custom_params(self, test_dict, test_list):
     mock_class = MockClass()
 
     def test_class_method_with_default_params(self):
-        expected_output = "INFO:secure_logger.decorators:secure_logger: __main__.decorator_with_defaults() ['<__main__.TestClassMethodDecorator.MockClass"
+        expected_output = "INFO:secure_logger.decorators:secure_logger: tests.decorator_with_defaults() ['<tests.TestClassMethodDecorator.MockClass"
 
         with self.assertLogs(level=logging.DEBUG) as cm:
             self.mock_class.decorator_with_defaults(self.test_dict, self.test_list)
@@ -144,7 +144,7 @@ class MockDecoratedClass(object):
 
             pass
 
-        expected_output = "INFO:secure_logger.decorators:secure_logger: __main__.MockDecoratedClass.  "
+        expected_output = "INFO:secure_logger.decorators:secure_logger: tests.MockDecoratedClass.  "
 
         with self.assertLogs(level=logging.DEBUG) as cm:
             mock_decoratorated_class = MockDecoratedClass()

tests.py renamed to secure_logger/tests/tests.py

@@ -1,11 +1,10 @@
 [flake8]
 ignore = E128,E731,W503,W504
-max-line-length = 512
+max-line-length = 120
 exclude=venv/
 
 [tool:pytest]
-norecursedirs=venv* .tox .eggs build dist secure_logger.egg-info secure_logger/mongodb
-addopts = --doctest-modules --doctest-ignore-import-errors --nomigrations --cov=secure_logger --cov-report html --cov-report term
+norecursedirs=venv* .tox .eggs build dist secure_logger.egg-info
 
 [isort]
 combine_as_imports = true
@@ -17,6 +16,6 @@ line_length=128
 
 [pycodestyle]
 count = False
-max-line-length = 512
+max-line-length = 120
 statistics = True
 ignore = D100,D101,D102,D103,D104,D105,D106,D107,D202,D203,D205,D210,D212,D400,D406,D407,D412,D413

setup.cfg

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+import subprocess
+import unittest
+
+
+class TestSetup(unittest.TestCase):
+    """Test setup.py."""
+
+    def test_setup_syntax(self):
+        """Test setup.py syntax."""
+        result = subprocess.run(["python", "setup.py", "check"], capture_output=True, text=True)
+        assert result.returncode == 0, f"setup.py failed with output:\n{result.stdout}\n{result.stderr}"
+        assert not result.stderr, "Expected no error output"
+
+
+if __name__ == "__main__":
+    unittest.main()

setup_test.py

@@ -6,13 +6,10 @@ skip_missing_interpreters = true
 
 [gh-actions]
 python =
-    3.8: gitlint,py38,flake8
-    3.9: gitlint,py39,flake8
-    3.10: gitlint,py310,flake8
     3.11: gitlint,py311,flake8
 
 [testenv]
-deps = -rrequirements.txt
+deps = -rrequirements/local.txt
 commands = pytest
 
 [flake8]