Skip to main content

Audit log app for Django

Project description

django-auditlog

Jazzband Build Status Docs codecov Supported Python versions Supported Django versions

Migrate to V3

Check the Upgrading to version 3 doc before upgrading to V3.

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 https://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. Update the CHANGELOG release date
  4. Pull request vX.Y.Z -> master
  5. As a project lead, once the PR is merged, create and push a tag vX.Y.Z: this will trigger the release build and a notification will be sent from Jazzband of the availability of two packages (tgz and wheel)
  6. Test the install
  7. Publish the release to PyPI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_auditlog-3.2.0.tar.gz (72.6 kB view details)

Uploaded Source

Built Distribution

django_auditlog-3.2.0-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

Details for the file django_auditlog-3.2.0.tar.gz.

File metadata

  • Download URL: django_auditlog-3.2.0.tar.gz
  • Upload date:
  • Size: 72.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for django_auditlog-3.2.0.tar.gz
Algorithm Hash digest
SHA256 66cf3945977ba60e0687fc264ac178f0c7b0eee013f25e1c63561d8ceb6a5c41
MD5 fad40e9c14dced071b9951fb17a15ce1
BLAKE2b-256 3ed316b3a4b4fc2974067263182065d90c04770d6bcf4e6cfa45af196c2a7ed5

See more details on using hashes here.

File details

Details for the file django_auditlog-3.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_auditlog-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 63d02326c5b069cd5ae390c4729076f1d935c3a9cefc27893e79a01c42cd1a78
MD5 37f69f8818852cce2ae338343a10ba48
BLAKE2b-256 4111f5a7323b7fc88e7248bbc26c80fc7dfed98d7deef4ef7f70b7a7c57f5797

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page