Hopiu/django-auditlog
1
0
Fork 0
mirror of https://github.com/jazzband/django-auditlog.git synced 2026-03-16 22:20:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
A Django app that keeps a log of changes made to an object.
273 commits 7 branches 77 tags 2.5 MiB
Python 97.4%
HTML 1.6%
Makefile 0.5%
Shell 0.5%
Find a file
Jan-Jelle Kester 4e7c640ba0 Bump copyright year
2020-09-07 16:52:32 +02:00
auditlog Clean up project structure 2020-09-07 16:52:32 +02:00
auditlog_tests Clean up project structure 2020-09-07 16:52:32 +02:00
docs Clean up project structure 2020-09-07 16:52:32 +02:00
.gitignore Clean up project structure 2020-09-07 16:52:32 +02:00
.travis.yml Clean up project structure 2020-09-07 16:52:32 +02:00
LICENSE Bump copyright year 2020-09-07 16:52:32 +02:00
README.md (docs) Update README to include steps to release (#185) 2018-09-17 14:56:44 -04:00
requirements.txt Clean up project structure 2020-09-07 16:52:32 +02:00
runtests.py Clean up project structure 2020-09-07 16:52:32 +02:00
setup.py Clean up project structure 2020-09-07 16:52:32 +02:00
tox.ini Clean up project structure 2020-09-07 16:52:32 +02:00

README.md

django-auditlog

Build Status Docs

Please remember that this app is still in development. Test this app before deploying it in production environments.

django-auditlog (Auditlog) is a reusable app for Django that makes logging object changes a breeze. Auditlog tries to use as much as Python and Django’s built in functionality to keep the list of dependencies as short as possible. Also, Auditlog aims to be fast and simple to use.

Auditlog is created out of the need for a simple Django app that logs changes to models along with the user who made the changes (later referred to as actor). Existing solutions seemed to offer a type of version control, which was found excessive and expensive in terms of database storage and performance.

The core idea of Auditlog is similar to the log from Django’s admin. Unlike the log from Django’s admin (django.contrib.admin) Auditlog is much more flexible. Also, Auditlog saves a summary of the changes in JSON format, so changes can be tracked easily.

Documentation

The documentation for django-auditlog can be found on http://django-auditlog.readthedocs.org. The source files are available in the docs folder.

License

Auditlog is licensed under the MIT license (see the LICENSE file for details).

Contribute

If you have great ideas for Auditlog, or if you like to improve something, feel free to fork this repository and/or create a pull request. I'm open for suggestions. If you like to discuss something with me (about Auditlog), please open an issue.

Releases

  1. Make sure all tests on master are green.
  2. Create a new branch vX.Y.Z from master for that specific release.
  3. Bump versions in setup.py and docs/source/conf.py (docs have 2 places where the versions need to be changed!)
  4. Pull request vX.Y.Z -> stable. Merging policy is very strict. This triggers a new release.
  5. Pull request stable -> master. Now everything is back in sync.

Opening a pull request from master directly to stable is discouraged as master may be updated while the PR is open, thus changing the contents of the release.