django-simple-history¶

django-simple-history stores Django model state on every create/update/delete.

This app supports the following combinations of Django and Python:

Django	Python
2.2	3.6, 3.7, 3.8, 3.9
3.1	3.6, 3.7, 3.8, 3.9
3.2	3.6, 3.7, 3.8, 3.9

Contribute¶

• Issue Tracker: https://github.com/jazzband/django-simple-history/issues

• Source Code: https://github.com/jazzband/django-simple-history

Pull requests are welcome.

Documentation¶

• Quick Start
  • Install
  • Configure
  • Run Migrations
  • What Now?
  • What is django-simple-history Doing Behind the Scenes?
• Querying History
  • Querying history on a model instance
  • Querying history on a model class
  • Getting previous and next historical record
  • Reverting the Model
  • as_of
  • most_recent
  • Save without a historical record
  • Filtering data using a relationship to the model
• Admin Integration
  • Displaying custom columns in the admin history list view
  • Disabling the option to revert an object
• Historical Model Customizations
  • Custom history_id
  • Custom history_date
  • Custom history table name
  • Custom model name
  • TextField as history_change_reason
  • Change Base Class of HistoricalRecord Models
  • Excluded Fields
  • Adding additional fields to historical models
  • Change Reason
  • Deleting historical record
  • Allow tracking to be inherited
  • History Model In Different App
  • FileField as a CharField
• User Tracking
  • Recording Which User Changed a Model
  • Change User Model
• Signals
• History Diffing
• Multiple databases
  • Interacting with Multiple Databases
  • Tracking User in a Separate Database
  • Tracking History Separate from the Base Model
• Utils
  • clean_duplicate_history
  • clean_old_history
• Common Issues
  • Bulk Creating and Queryset Updating
  • Tracking Custom Users
  • Using django-webtest with Middleware
  • Using F() expressions
  • Reserved Field Names
  • Multi-table Inheritance
  • Usage with django-modeltranslation
  • Pointing to the model
  • Working with BitBucket Pipelines