Save model history
Project description
django-model-history-log
Register fields updates.
Install
Add model_history.apps.ModelHistoryConfig
into your INSTALLED_APPS
#!python
INSTALLED_APPS = [
...
"model_history.apps.ModelHistoryConfig",
...
]
and than run
./manage.py migrate
Configure
Register a model at startup
You can register a model for logging at startup using History.register
helper:
class MyAppConfig(AppConfig):
name = "myapp"
def ready(self):
from model_history.models import History
from django.contrib.auth import get_user_model
History.register(get_user_model(), exclude=["password"])
You can register all models with a snippet like this
class MyAppConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "myapp"
verbose_name = _("My Website")
def ready(self):
from django.contrib.admin.models import LogEntry
from django.contrib.auth import get_user_model
from django.contrib.sessions.models import Session
from model_history.models import History, HistoryLog
User = get_user_model()
History.register(User, exclude=["password"])
for model in apps.get_models():
if model not in [LogEntry, History, HistoryLog, Session, User]:
History.register(model)
Usage
Log a single instance
You can log a single instance changes with the HistoryManager.log()
method:
instance = MyInstance.objects.get(...)
...
History.objects.log(instance)
Params
instance
:models.Model
= instance to logexclude
:list[str] | None
= exclude these fields from loggingserializer_class
:rest_framework.serializers.Serializer | None
= use this serializer instance
Query a log
from django.contrib.auth import get_user_model
history = History.objects.fetch(User.objects.first())
history.logs.all()
fetch()
always returns an History instance, regardless it is saved on db or not.
You must rely on it's pk
value or you should check for logs
.
CHANGES
0.2.0
- Rename project to django-model-history-log (sorry, no migration path)
- Reformat all codebase with black
- Update isort/flake8 config
- Use django JSONField
- Remove default ordering, use only in admin
- Add register/unregister actions
- Add HistoryQuerySet.fetch api
- Save str(source) as {History,HistoryLog}.label
- Add en translations
- Add it translations
0.1.1
- added missing
on_delete
on HistoryRow.history field
0.1.0
- initial relase
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-model-history-log-0.2rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb24d6f1083e80dfe3059be1400d642faa07f6fbb2673272c9423a4a00b22abe |
|
MD5 | 9b1487c60c436427986e8931ea736314 |
|
BLAKE2b-256 | 9f6a1ac71f82f0f09fe0f0cb42ab2f140770effffca632bb3f4547ebbd787491 |
Close
Hashes for django_model_history_log-0.2rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e1ce9be2db3708f9c72152e10a73d50d9423dd93a2a7661fe003c20d11e0bbb |
|
MD5 | 7c81700ac76515956282d878c8a5811c |
|
BLAKE2b-256 | 8a2ff96183cf355d2af261f04911a0589aebc326e216c9dac8c5972efc4c2f9c |