Metadata-Version: 2.1
Name: drf-audit-trail
Version: 0.2.1
Summary: A reusable django [DRF] application that handles auditing of requests and logins
Home-page: https://github.com/Talismar/drf-audit-trail
Author: Talismar Fernandes Costa
Author-email: talismar788.una@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: django (>=4,<5)
Requires-Dist: djangorestframework (==3.14.0)
Requires-Dist: djangorestframework-simplejwt (==5.2.2)
Project-URL: Repository, https://github.com/Talismar/drf-audit-trail
Description-Content-Type: text/markdown

# DRF Audit Trail

A reusable django [DRF] application that handles auditing of requests and logins

## Features

- Request audit trail
- Logins audit trail
- Integration simplejwt

## Usage

Para usar este app, você precisa efetuar a instação do mesmo e logo apos adicionar-lo ao INSTALLED_APPS do Django e configurar o middlewares no array de middlewares do seu django settings

#### Installation
```sh
pip install drf-audit-trail
```

#### Add to Django INSTALLED_APPS configuration
```python
# settings.py

INSTALLED_APPS = [
    ...
    "drf_audit_trail"
]
```

#### Add to Django MIDDLEWARE configuration
```python
# settings.py

MIDDLEWARE = [
    ...
    "drf_audit_trail.middleware.RequestLoginAuditEventMiddleware",
]
```

## Flow
![DER](https://github.com/Talismar/drf-audit-trail/blob/develop/docs/flow.png?raw=True)

## DER
![DER](https://github.com/Talismar/drf-audit-trail/blob/develop/docs/DER.png?raw=True)

## RequestLoginAuditEventMiddleware class diagram
![DER](https://github.com/Talismar/drf-audit-trail/blob/develop/docs/middleware_class_diagram.png?raw=True)


