Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/darknessrdg/django-paranoid-model

Django abstract model with paranoid behavior
https://github.com/darknessrdg/django-paranoid-model

delete django django-models orm paranoid python timestamp

Last synced: 2 months ago
JSON representation

Django abstract model with paranoid behavior

Awesome Lists containing this project

README

        



Build Status


Code quality


Coverage


License


Issues


Open pull requests











**Read the docs: **

# django-paranoid-model

Django abstract model with paranoid behavior, therefore when an instance is deleted it is not really deleted from database, it's applied a mask on the filter so when filter, the result are the "undeleted" instances.

Sometimes you might want to keep all datas saved on your database and when user wants do delete, it is just hidden form user.

All documentation are in the `mkdocs/docs` directory and online at [HERE !!](https://darknessrdg.github.io/django-paranoid-model/). If you're new here, we recomend you to checkout the documentation first :wink: .

## Quick start

Install Django Paranoid Model package from pip

```py
pip install django-paranoid-model
```

Add paranoid_model to your installed apps so you can use django admin with a paranoid behavior

```py
INSTALLED_APPS = [
...
'paranoid_model'
]
```

Good job ! You're now ready to use it.

Run tests
---------
```
pip install -e .[test]
pytest
```
or run Tox to test on multiple Django versions
```
pip install tox
tox
```