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.
556 commits 7 branches 77 tags 2.5 MiB
Python 97.4%
HTML 1.6%
Makefile 0.5%
Shell 0.5%
Find a file
Youngkwang Yang af78976e53
Add support for custom masking functions (#725) 
* Add test cases for the `mask_str` function

* Add custom masking function support through mask_callable

* Add test cases for custom masking function

* Update documentation for custom masking function

* fix test case

* rename `AUDITLOG_DEFAULT_MASK_CALLABLE` variable

-AUDITLOG_DEFAULT_MASK_CALLABLE to `AUDITLOG_MASK_CALLABLE`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update `CHANGELOG.md` to include mask function customization feature

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-06-09 16:59:59 +03:30
.github Pin libraries to fix release (#718) 2025-04-26 12:57:00 +02:00
auditlog Add support for custom masking functions (#725) 2025-06-09 16:59:59 +03:30
auditlog_tests Add support for custom masking functions (#725) 2025-06-09 16:59:59 +03:30
docs Add support for custom masking functions (#725) 2025-06-09 16:59:59 +03:30
.gitignore Added remote port (#671) 2024-10-07 15:52:34 +02:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#708) 2025-04-07 16:21:40 +03:30
.readthedocs.yaml pip install . during RTD build (#578) 2023-10-27 19:31:36 +03:30
CHANGELOG.md Add support for custom masking functions (#725) 2025-06-09 16:59:59 +03:30
CODE_OF_CONDUCT.md Jazzband: Created local 'CODE_OF_CONDUCT.md' from remote 'CODE_OF_CONDUCT.md' 2022-01-04 11:27:52 +01:00
CONTRIBUTING.md Changes for Jazzband (#269) 2020-10-23 12:16:27 +02:00
LICENSE Bump copyright year 2020-09-07 16:52:32 +02:00
pyproject.toml Drop Python 3.8 support (#678) 2024-10-17 18:40:21 +02:00
README.md Add note about V3 to readme (#626) 2024-04-07 21:36:13 +02:00
setup.py Add Python 3.13 support (#697) 2025-01-29 11:34:47 +03:30
tox.ini Let CI also check for missing migrations (#706) 2025-03-19 19:58:43 +03:30

README.md

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