https://github.com/william-fernandes252/django-activity-tracker

A reusable Django application to track user actions through the database.
https://github.com/william-fernandes252/django-activity-tracker

django postgresql python

Last synced: 3 months ago
JSON representation

A reusable Django application to track user actions through the database.

• Host: GitHub
• URL: https://github.com/william-fernandes252/django-activity-tracker
• Owner: William-Fernandes252
• License: mit
• Created: 2023-11-06T21:58:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-12T16:25:56.000Z (over 2 years ago)
• Last Synced: 2025-10-25T19:54:42.553Z (8 months ago)
• Topics: django, postgresql, python
• Language: Python
• Homepage: https://william-fernandes252.github.io/django-activity-tracker/
• Size: 396 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Django Activity Tracker

[![pypi](https://img.shields.io/pypi/v/django-activity-tracker.svg)](https://pypi.org/project/django-activity-tracker/)

[![python](https://img.shields.io/pypi/pyversions/django-activity-tracker.svg)](https://pypi.org/project/django-activity-tracker/)

[![Build Status](https://github.com/William-Fernandes252/django-activity-tracker/actions/workflows/dev.yml/badge.svg)](https://github.com/William-Fernandes252/django-activity-tracker/actions/workflows/dev.yml)

[![codecov](https://codecov.io/gh/William-Fernandes252/django-activity-tracker/branch/main/graphs/badge.svg)](https://codecov.io/github/William-Fernandes252/django-activity-tracker)

A reusable Django application to track user actions through the database.

-   Documentation: 

-   GitHub: 

-   PyPI: 

-   Free software: MIT

## Introduction

I once worked on a project where user interactions about business entities needed to be recorded, in a detailed and consistent manner, in the database for auditing reasons. When a user changed the state of an object, the change, along with its author and time, should be saved. Furthermore, the object in question should be easily located. As I came up with a conveniently generic solution, I decided to turn this into a reusable application for Django projects.

Currently it works only in [Django REST Framework](https://www.django-rest-framework.org/) projects, and with [`ModelViewSet`s](https://www.django-rest-framework.org/api-guide/viewsets/), but in the future I plan to support Django CBVs and view functions as well.

## Features

-   Track users interations with any model of your project in a _generic_ way;

-   Retrive and protect this information;

-   Use the full capabilities of the Django ORM to gather information about what a specific user did to an object, what users interacted with it, and more!

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage) project template.