Django Models
Para visualizar o README em portugues.
Django Models is a Library with several useful Models for Django to help you make your templates smart or with less code
Requirements
- Python 3.8 or later
- Django 1.11 or later
Features
Generic Models
ActiveModel
Model with is_active boolean field
CodeModel
Model with a code field that automatically generates a hash of 16 characters by default. Useful to identify your record in a more humane way
SerializerModel
Model to return a dict with all data of your django instance without a serializer.
Example:
Your Model
...
class YourModel(SerializerModel)
name = models.CharField(max_length=255)
...
Usage
In[2]: instance = YourModel.objects.first()
In[3]: user.serialize()
Out[3]: {'id': 1, 'name': 'first record', ...}
SlugModel
Model with a slug field. Useful to use in urls or nominal references
TimestampedModel
Model with the DateTime, created_at and updated_at fields. Useful to control when any changes were made.
UUIDModel
Model that uses the id field as a UUID. Useful to be able to have a unique identifier without worrying about sequences.
History models
- HistoryModel Model that tracks each save to generate a Change History of a record
Signals Models
With SignalsModel it allows you to handle or execute an event according to Django's Signals.
- On Save:
- pre_save (Before Saving)
- post_save (After Saving)
- On Delete:
- pre_delete (Before Deleting)
- post_delete (After Deleting)
Example using Pre-save signal
Note: This will be made before you save your model
...
class YourModel(SignalsModel)
...
def pre_save(self):
do_something()
Soft Delete Signal Model
SoftDeleteSignalModel Models
It is the SignalsModel with soft delete implemented. Ensures that nothing you delete is really deleted from the system and easy to recover
How to install
Getting It
You can get Django Models by using pip:
If you want to install it from source, grab the git repository from GitHub and run setup.py:
$ cd django_models
$ python setup.py install
Settings
To enable django_models in your project you need to add it to INSTALLED_APPS in your projects settings.py file:
...
'django_models',
...
)
Documentation
Check out the latest django-models documentation at GitHub Pages
Contributing
Please send pull requests, very much appreciated.
- Fork the repository on GitHub.
- Make a branch off of master and commit your changes to it.
- Install requirements.
pip install -r requirements-dev.txt - Install pre-commit.
pre-commit install - Run the tests with
cd test-django-project; py.test -vv -s - Create a Pull Request with your contribution