Metadata-Version: 2.2
Name: django-trackmate
Version: 0.1.0
Summary: Add your description here
Author-email: Aimé DEGBEY <aime.degbey@kodesio.com>
License: MIT License
        
        Copyright (c) 2025 Aimé DEGBEY
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django>=3.2


# django-trackmate

**django-trackmate** is a lightweight and customizable Django package for tracking API requests, login/logout activities, and user-defined actions within your application. This package is designed to simplify activity tracking and help you gain actionable insights into user behavior.

---

## 🚀 Features

- **Request Logging**: Automatically log incoming API requests with detailed metadata.
- **Login/Logout Tracking**: Monitor user authentication events seamlessly.
- **Custom Action Logs**: Track user actions across your application.
- **Django Admin Integration**: View, filter, and manage activity logs in the admin panel.
- **GenericForeignKey Support**: Log actions related to various models effortlessly.
- **Highly Configurable**: Exclude paths, customize log details, and more.

---

## 📦 Installation

1. Using pip:

   ```bash
   pip install django-trackmate
   ```
   
   or using uv:

   ```bash
   uv add django-trackmate
   ```

2. Add `trackmate` to your `INSTALLED_APPS` in `settings.py`:

   ```python
   INSTALLED_APPS = [
       ...
       'django_trackmate',
   ]
   ```

3. Run migrations to set up the necessary database tables:

   ```bash
   python manage.py makemigrations django_trackmate
   python manage.py migrate
   ```

---

## 🛠 Usage

### Logging Custom Actions
Use the `tracker` decorator to log custom actions:

```python
from django_trackmate import tracker

@tracker()
def my_api_view(request):
    ...
```

### Extending Functionality
Directly create activity logs using the `ActivityLog` model:

```python
from django_trackmate.models import ActivityLog

    ActivityLog.objects.create(
        actor=None,
        action_type=LOGIN_FAILED,
        action_time=datetime.now(),
        remarks=message
    )
```

### Parameters
- `content_object`: An instance of a Django model to link to the activity log.
- `actor`: The user who performed the action.
- `action_type`: The type of action being logged. Choices: "Create", "Read", "Update", "Delete", "Login", "Logout", "Login Failed".
- `action_time`: The timestamp of the action.
- `remarks`: Additional details about the action.
- `ip_address`: The IP address of the user's request.
- `status`: The status of the action. Choices: "Success", "Failed".
- `status_code`: The HTTP status code associated with the action.
- `response`: The response data associated with the action.
- `data`: The request data associated with the action.

---

## 📊 Viewing Logs

- View logs in the Django Admin under the **Activity Logs** section.
- Use filters to sort by user, action type, timestamp, or related object.

---

## 🧪 Running Tests

Run the test suite to ensure everything is functioning correctly:

```bash
python manage.py test trackmate
```

---

## 💡 Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Submit a pull request with a detailed description of the changes.

---

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

---

## 📧 Support

If you encounter any issues or have questions, feel free to open an issue on GitHub or email us at **aime.degbey@kodesio.com**.

---

## 🏗 Built With

- **Django**: The web framework for perfectionists with deadlines.
- **Python**: Simplicity and flexibility for building scalable software.
