django-models 1.0
Library with several useful Models for Django to help you make your Models smart or with less code
License: MIT
Keywords: models tools django signal

=============
Django Models
=============

`Para visualizar o README em português <https://github.com/rhenter/django-models/blob/master/README.pt.rst>`_.

|PyPI latest| |PyPI Version| |PyPI License|  |GitHub Actions Status| |Coverage| |Docs| |Open Source? Yes!|

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**

.. code-block:: python

    from django_models.models import SerializerModel
    ...

    class YourModel(SerializerModel)
        name = models.CharField(max_length=255)
        ...

**Usage**

.. code-block:: python

    In[1]: from . import YourModel
    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

.. code-block:: python

    from django_models.models import SignalsModel
    ...

    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:

.. code:: shell

    $ pip install django-models


If you want to install it from source, grab the git repository from GitHub and run setup.py:

.. code:: shell

    $ git clone git@github.com:rhenter/django_models.git
    $ 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:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'django_models',
        ...
    )


Documentation
=============

Check out the latest ``django-models`` documentation at `GitHub Pages <https://rhenter.github.io/django-models/>`_


Contributing
============

Please send pull requests, very much appreciated.


1. Fork the `repository <https://github.com/rhenter/django_models>`_ on GitHub.
2. Make a branch off of master and commit your changes to it.
3. Install requirements. ``pip install -r requirements-dev.txt``
4. Install pre-commit. ``pre-commit install``
5. Run the tests with ``cd test-django-project; py.test -vv -s``
6. Create a Pull Request with your contribution


.. |Docs| image:: https://img.shields.io/static/v1?label=DOC&message=GitHub%20Pages&color=%3CCOLOR%3E
   :target: https://rhenter.github.io/django-models/
.. |PyPI Version| image:: https://img.shields.io/pypi/pyversions/django-models.svg?maxAge=60
   :target: https://pypi.python.org/pypi/django-models
.. |PyPI License| image:: https://img.shields.io/pypi/l/django-models.svg?maxAge=120
   :target: https://github.com/rhenter/django-models/blob/master/LICENSE
.. |PyPI latest| image:: https://img.shields.io/pypi/v/django-models.svg?maxAge=120
   :target: https://pypi.python.org/pypi/django-models
.. |GitHub Actions Status| image:: https://github.com/rhenter/django-models/workflows/Tests/badge.svg
   :target: https://github.com/rhenter/django-models/actions/workflows/ci.yml
.. |Coverage| image:: https://codecov.io/gh/rhenter/django-models/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/rhenter/django-models
.. |Open Source? Yes!| image:: https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github
   :target: https://github.com/rhenter/django-models