django-activity-audit 1.3.0.dev6__tar.gz → 1.3.0.dev8__tar.gz

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-activity-audit
-Version: 1.3.0.dev6
+Version: 1.3.0.dev8
 Summary: A Django package for easy CRUD operation logging and container logs
 Project-URL: Homepage, https://github.com/shree256/django-activity-audit
 Project-URL: Repository, https://github.com/shree256/django-activity-audit
@@ -117,7 +117,12 @@ LOGGING = {
 }
 ```
 
-5. For external services logging, extend ```HTTPClient or SFTPClient```
+5. Configure the service name in `settings.py` (optional, defaults to `"default"`):
+```python
+AUDIT_SERVICE_NAME = "my_service"
+```
+
+6. For external services logging, extend ```HTTPClient or SFTPClient```
 ```python
 class ExternalService(HTTPClient):
     def __init__(self):
@@ -128,7 +133,7 @@ class ExternalService(HTTPClient):
         response = self.get(url) # sample log structure below
 ```
 
-7. Create ```audit_logs``` folder in project directory
+8. Create ```audit_logs``` folder in project directory
 
 ## Log Types
 
@@ -192,7 +197,7 @@ INFO 2025-04-30 08:51:10,403 /app/patients/api/utils.py utils create_patient_wit
     "level": "API",
     "name": "audit.request",
     "message": "Audit Internal Request",
-    "service_name": "review_board",
+    "service_name": "my_service",
     "request_type": "internal",
     "protocol": "http",
     "user_id": "14ab1197-ebdd-4300-a618-5910e0219936",

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/README.md

@@ -77,7 +77,12 @@ LOGGING = {
 }
 ```
 
-5. For external services logging, extend ```HTTPClient or SFTPClient```
+5. Configure the service name in `settings.py` (optional, defaults to `"default"`):
+```python
+AUDIT_SERVICE_NAME = "my_service"
+```
+
+6. For external services logging, extend ```HTTPClient or SFTPClient```
 ```python
 class ExternalService(HTTPClient):
     def __init__(self):
@@ -88,7 +93,7 @@ class ExternalService(HTTPClient):
         response = self.get(url) # sample log structure below
 ```
 
-7. Create ```audit_logs``` folder in project directory
+8. Create ```audit_logs``` folder in project directory
 
 ## Log Types
 
@@ -152,7 +157,7 @@ INFO 2025-04-30 08:51:10,403 /app/patients/api/utils.py utils create_patient_wit
     "level": "API",
     "name": "audit.request",
     "message": "Audit Internal Request",
-    "service_name": "review_board",
+    "service_name": "my_service",
     "request_type": "internal",
     "protocol": "http",
     "user_id": "14ab1197-ebdd-4300-a618-5910e0219936",

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/README.rst

@@ -76,7 +76,11 @@ Installation
         }
     }
 
-5. For external services logging, extend ``HTTPClient`` or ``SFTPClient``::
+5. Configure the service name in ``settings.py`` (optional, defaults to ``"default"``)::
+
+    AUDIT_SERVICE_NAME = "my_service"
+
+6. For external services logging, extend ``HTTPClient`` or ``SFTPClient``::
 
     class ExternalService(HTTPClient):
         def __init__(self):
@@ -86,7 +90,7 @@ Installation
             url = "https://www.sample.com"
             response = self.get(url) # sample log structure below
 
-6. Create ``audit_logs`` folder in project directory
+7. Create ``audit_logs`` folder in project directory
 
 Log Types
 ---------
@@ -158,7 +162,7 @@ Incoming Log Format::
         "level": "API",
         "name": "audit.request",
         "message": "Audit Internal Request",
-        "service_name": "review_board",
+        "service_name": "my_service",
         "request_type": "internal",
         "protocol": "http",
         "user_id": "14ab1197-ebdd-4300-a618-5910e0219936",

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/activity_audit/middleware.py

@@ -10,7 +10,7 @@ from django.http import HttpResponse
 from django.utils.deprecation import MiddlewareMixin
 
 from .constants import REQUEST_TYPES
-from .settings import REGISTERED_URLS, UNREGISTERED_URLS
+from .settings import REGISTERED_URLS, SERVICE_NAME, UNREGISTERED_URLS
 
 logger = logging.getLogger("audit.request")
 
@@ -116,7 +116,7 @@ class AuditLoggingMiddleware(MiddlewareMixin):
     def __init__(self, get_response):
         self.get_response = get_response
         self.log_data = {
-            "service_name": "review_board",
+            "service_name": SERVICE_NAME,
             "request_type": REQUEST_TYPES[0],
             "protocol": None,
             "user_id": "",

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/activity_audit/protocols.py

@@ -4,8 +4,8 @@ import time
 from typing import Optional, Tuple
 
 import paramiko
-from django.conf import settings
 
+from django.conf import settings
 from requests.sessions import Session
 
 from .constants import REQUEST_TYPES
@@ -218,12 +218,12 @@ class SFTPClient:
                     result = f"{filename} uploaded successfully to {path_to_folder}"
                     logger.info(f"{result}")
                 except Exception as e:
-                    self.log_payload["error_message"] = (
-                        f"File upload failed. Error: {str(e)}"
-                    )
-            self.log_payload["error_message"] = (
-                f"Path validation failed. Error: {str(error)}"
-            )
+                    self.log_payload[
+                        "error_message"
+                    ] = f"File upload failed. Error: {str(e)}"
+            self.log_payload[
+                "error_message"
+            ] = f"Path validation failed. Error: {str(error)}"
         else:
             self.log_payload["error_message"] = "Connection not established"
 

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/activity_audit/settings.py

@@ -44,12 +44,12 @@ UNREGISTERED_CLASSES = [
 SILK_INSTALLED = apps.is_installed("silk")
 if SILK_INSTALLED:
     from silk.models import (
+        BaseProfile,
+        Profile,
         Request,
         Response,
-        SQLQueryManager,
         SQLQuery,
-        BaseProfile,
-        Profile,
+        SQLQueryManager,
     )
 
     UNREGISTERED_CLASSES.extend(
@@ -78,3 +78,6 @@ UNREGISTERED_URLS.extend(getattr(settings, "AUDIT_UNREGISTERED_URLS_EXTRA", []))
 
 # URL patterns to include in logging (if empty, all URLs are logged)
 REGISTERED_URLS = getattr(settings, "AUDIT_REGISTERED_URLS", [])
+
+# Service name for audit logs
+SERVICE_NAME = getattr(settings, "AUDIT_SERVICE_NAME", "default")

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/activity_audit/signals.py

@@ -79,25 +79,7 @@ def get_calling_model() -> Optional[str]:
     return None
 
 
-class ModelSignalMixin:
-    """Mixin to add signal handling capabilities to models."""
-
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, **kwargs)
-        self._original_m2m = self._get_m2m_state()
-
-    def _get_m2m_state(self) -> dict:
-        try:
-            """Get the current state of M2M fields."""
-            return {
-                field.name: set(
-                    getattr(self, field.name).all().values_list("id", flat=True)
-                )
-                for field in self._meta.many_to_many
-            }
-        except Exception as e:
-            logger.error(f"Error getting M2M state: {e}")
-            return {}
+_patched_models: set = set()
 
 
 def push_log(
@@ -131,12 +113,15 @@ def push_log(
         logger.error(f"Failed to prepare audit log: {e}")
 
 
+def instance_to_dict(instance: models.Model) -> dict:
+    return model_to_dict(instance, fields=[f.name for f in instance._meta.fields])
+
+
 def patch_model_event(model_class: type[models.Model]) -> None:
     """Monkey patch a model to add signal handling capabilities."""
 
-    if not issubclass(model_class, ModelSignalMixin):
-        # Add the mixin to the model's base classes
-        model_class.__bases__ = (ModelSignalMixin,) + model_class.__bases__
+    if model_class not in _patched_models:
+        _patched_models.add(model_class)
 
         # Store the original methods
         original_save = model_class.save
@@ -154,7 +139,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
             # Log the event
             event_type = EVENT_TYPES[0] if is_new else EVENT_TYPES[1]
 
-            instance_repr = model_to_dict(self)
+            instance_repr = instance_to_dict(self)
 
             push_log(
                 f"{event_type} event by {model_class.__name__} (id: {self.pk})",
@@ -179,7 +164,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
 
             # For new instances, we might not have a pk yet, so use a placeholder
             instance_id = str(instance.pk) if instance.pk else "pending"
-            instance_repr = model_to_dict(instance)
+            instance_repr = instance_to_dict(instance)
 
             push_log(
                 f"{event_type} event by {model_class.__name__} (id: {instance_id})",
@@ -208,7 +193,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
             # Log only if this is the calling model
             if calling_model == model_class.__name__:
                 first_obj = created_objs[0]
-                instance_repr = model_to_dict(first_obj)
+                instance_repr = instance_to_dict(first_obj)
 
                 push_log(
                     f"{EVENT_TYPES[3]} event by {model_class.__name__} (id: {first_obj.pk})",
@@ -231,17 +216,17 @@ def patch_model_event(model_class: type[models.Model]) -> None:
                 return original_bulk_update(self, objs, fields, batch_size)
 
             # Call the original bulk_update method
-            original_bulk_update(self, objs, fields, batch_size)
+            bulk_update = original_bulk_update(self, objs, fields, batch_size)
 
             # Get the calling model
             calling_model = get_calling_model()
             if not calling_model:
-                return original_bulk_update(self, objs, fields, batch_size)
+                return bulk_update
 
             # Log only if this is the calling model
             if calling_model == model_class.__name__:
                 first_obj = objs[0]
-                instance_repr = model_to_dict(first_obj)
+                instance_repr = instance_to_dict(first_obj)
 
                 push_log(
                     f"{EVENT_TYPES[4]} event by {model_class.__name__}",
@@ -268,7 +253,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
             if not should_audit(instance):
                 return
 
-            instance_repr = model_to_dict(instance)
+            instance_repr = instance_to_dict(instance)
 
             push_log(
                 f"{EVENT_TYPES[8]} event by {model_class.__name__} (id: {instance.pk})",
@@ -283,7 +268,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
         def handle_delete(
             sender: type[models.Model], instance: models.Model, **kwargs: Any
         ) -> None:
-            instance_repr = model_to_dict(instance)
+            instance_repr = instance_to_dict(instance)
 
             push_log(
                 f"{EVENT_TYPES[2]} event by {model_class.__name__} (id: {instance.pk})",
@@ -308,7 +293,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
                     return
 
                 field_name = kwargs.get("model", sender).__name__.lower()
-                instance_repr = model_to_dict(instance)
+                instance_repr = instance_to_dict(instance)
 
                 push_log(
                     f"M2M {action} event by {model_class.__name__} (id: {instance.pk})",
@@ -330,7 +315,7 @@ def setup_model_signals() -> None:
             if not should_audit(model):
                 continue
 
-            if not issubclass(model, ModelSignalMixin):
+            if model not in _patched_models:
                 patch_model_event(model)
 
 

{django_activity_audit-1.3.0.dev6 → django_activity_audit-1.3.0.dev8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-activity-audit"
-version = "1.3.0.dev6"
+version = "1.3.0.dev8"
 description = "A Django package for easy CRUD operation logging and container logs"
 authors = [
     { name = "Shreeshan", email = "shreeshan256@gmail.com" }