hackforla / hackforla/peopledepot

Evaluate django-simple-history / django-auditlog for history tables

Open
#181 14 comments 0 reactions 1 assignee Claimed by @fyliu View on GitHub
complexity: medium feature: DB design PII: FALSE ready for dev lead role: back end s: PD team size: 3pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

We would like to know if django-simple-history can fulfill our needs of keeping history of certain tables. We can potentially save time and developer efforts.
The package automatically keeps track of change history metadata like who made the change.

### Details/Requirements

- [x] should be useful for #49 (issue closed)
- An event record has a long life with cancellations and overrides, and metadata about who made those changes should be useful
- [ ] not useful for ~#37~ (probably need this afterall)
- needs to hold the old permission records that are no longer in effect
- new permission records are created for each update, so there's no updating each record to keep track of
- [ ] should be useful for #67
- needs the history of the status field for each project

### Action Items

- [ ] install plugin into django and test the functionality
- [ ] evaluate whether it can fulfil our needs
- [ ] document usage if it's useful
- [ ] release the dependency on the following issues and if there are no other dependencies, move them from the icebox to the new issue approval column and add the `ready for dev lead` label.
- [ ] #49
- [ ] ~#37~ no longer applicable
- [ ] #67

### Resources/Instructions
- This issue was a part of #49
- [django-simple-history](https://github.com/jazzband/django-simple-history)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.