Skip to main content

Audit log app for Django

Project description

django-auditlog

Jazzband Build Status Docs codecov Supported Python versions Supported Django versions

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 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. 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 -> master.
  5. Pull request master -> stable. This merge triggers the deploy 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-1.0.0.tar.gz (36.4 kB view details)

Uploaded Source

Built Distribution

django_auditlog-1.0.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file django-auditlog-1.0.0.tar.gz.

File metadata

  • Download URL: django-auditlog-1.0.0.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django-auditlog-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c5fa676359df1e0bf573410cc1a12b9d0653f6cf44303c8a01edb36f42f5aec0
MD5 4e8a68944074555478a893ca5cf79e71
BLAKE2b-256 5044622b1a72cbc2133c5469c8808c50819d8f79f6c373be2fb238479d46656a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_auditlog-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django_auditlog-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72a4a94f13a349072716212dc6f7e802857e06ba89c4e589463fb633b60dcb45
MD5 7ead209449a30576da4c6bcf281d1b89
BLAKE2b-256 a8a55e146d087044a962f8c25c7653862c5a1cf674a670861245cdb90b68fbe1

See more details on using hashes here.

Supported by

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