rename decorator to secure_logger()

Author: lpm0073

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.1.1] (2023-04-25)
+
+- renamed to secure_logger
+
 ## [0.1.0] (2023-04-14)
 
 - initial release

Makefile

@@ -3,16 +3,6 @@
 # -------------------------------------------------------------------------
 .PHONY: build requirements deps-update deps-init
 
-django-server:
-	./manage.py runserver 0.0.0.0:8000
-
-django-shell:
-	./manage.py shell_plus
-
-
-django-test:
-	./manage.py test
-
 requirements:
 	pre-commit autoupdate
 	python -m pip install --upgrade pip wheel

README.md

@@ -31,13 +31,13 @@ pip install secure-logger
 ## Usage
 
 ```python
-from secure_logger.decorators import app_logger
+from secure_logger.decorators import secure_logger
 
 MY_SENSITIVE_KEYS = ["top-secret-password", "equally-secret-value",]
 
 class TestClass(object):
 
-    @app_logger(sensitive_keys=MY_SENSITIVE_KEYS, indent=4)
+    @secure_logger(sensitive_keys=MY_SENSITIVE_KEYS, indent=4)
     def test_2(self, test_dict, test_list):
         pass
 
@@ -51,10 +51,10 @@ o = TestClass()
 o.test_2(test_dict=test_dict, test_list=test_list)
 ```
 
-Output
+Generates log entries of this style and form:
 
 ```log
-INFO:app_logger: __main__.TestClass().test_2()  keyword args: {
+INFO:secure_logger: __main__.TestClass().test_2()  keyword args: {
     "test_dict": {
         "insensitive_key": "you-can-see-me",
         "top-secret-password": "*** -- REDACTED -- ***",

__about__.py

@@ -7,7 +7,7 @@
 
 # Increment this version number to trigger a new release. See
 # CHANGELOG.md for information on the versioning scheme.
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 # The app name will be used to define the name of the default plugin root and
 # plugin directory. To avoid conflicts between multiple locally-installed

pyproject.toml

@@ -24,7 +24,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 #------------------------------------------------------------------------------
 [project]
 name = "secure-logger"
-version = "0.1.0"
+version = "0.1.1"
 authors = [
   { name="Lawrence McDaniel", email="[email protected]" }
 ]

secure_logger/decorators.py

@@ -12,7 +12,7 @@
 logger = logging.getLogger(__name__)
 
 
-def app_logger(sensitive_keys: list = DEFAULT_SENSITIVE_KEYS, indent: int = 4):
+def secure_logger(sensitive_keys: list = DEFAULT_SENSITIVE_KEYS, indent: int = 4):
     """Top level decorator, for defining input parameters."""
 
     def decorate(func):
@@ -23,7 +23,7 @@ def decorate(func):
         its positional arguments, and keyword pairs presented as a formatted dict.
 
         Sample output:
-            2022-07-08 19:40:51,085 INFO app_logger: courses.views.CourseListingView().get_queryset()
+            2022-07-08 19:40:51,085 INFO secure_logger: courses.views.CourseListingView().get_queryset()
         """
 
         @wraps(func)
@@ -65,7 +65,7 @@ def wrapper(*args, **kwargs):
                 kwargs_dict_repr += serialized_masked_dict(kwargs, sensitive_keys=sensitive_keys, indent=indent)
 
             logger.info(
-                "app_logger: {name_spec} {args} {kwargs}".format(
+                "secure_logger: {name_spec} {args} {kwargs}".format(
                     name_spec=name_spec,
                     args=positional_args if len(positional_args) > 0 else "",
                     kwargs=kwargs_dict_repr,

tests.py

@@ -6,7 +6,7 @@
 """
 import logging
 
-from secure_logger.decorators import app_logger
+from secure_logger.decorators import secure_logger
 
 logging.basicConfig(level=logging.DEBUG)
 
@@ -18,7 +18,7 @@
 ]
 
 
-@app_logger(sensitive_keys=MY_SENSITIVE_KEYS, indent=4)
+@secure_logger(sensitive_keys=MY_SENSITIVE_KEYS, indent=4)
 def test_1(msg):
     """Test 1: a simple module function."""
     print("test 1: " + msg)  # noqa: T201
@@ -27,13 +27,13 @@ def test_1(msg):
 class TestClass(object):
     """Test class method logging."""
 
-    @app_logger()
+    @secure_logger()
     def test_2(self, test_dict, test_list):
         """Test class input parameter as objects."""
         pass
 
 
-@app_logger()
+@secure_logger()
 class Test3:
     """Test 3: decorate a class."""