Metadata-Version: 1.1
Name: edc-base
Version: 0.2.42
Summary: Base mixins and utilities for clinicedc/edc projects.
Home-page: http://github.com/clinicedc/edc-base
Author: Erik van Widenfelt
Author-email: ew2789@gmail.com
License: GPL license, see LICENSE
Description: |pypi| |travis| |coverage|
        
        edc-base
        --------
        
        Base model, manager, field, form and admin classes for Edc. 
        
        
        
        All models in the Edc use ``BaseUuidModel``
        
        .. code-block:: python
        
            from edc_base.model_mixins import BaseUuidModel
        
            class MyModel(BaseUuidModel):
        
                ....
        
        The mixin:
        
        * sets the id fields to a ``UUIDField`` instead of an integer;
        * adds audit fields through ``BaseModel`` (user_created, user_modified, date_created, etc);
        * adds ``UrlMixin``, ``DeviceModelMixin``
        
        Most models require an audit trail. If so, add the ``HistoricalRecord`` model manager.
        
        .. code-block:: python
        
            from edc_base.model.models import HistoricalRecord
            
            class MyModel(BaseUuidModel):
                
                ...
                history = HistoricalRecord()
                
        
        ``HistoricalRecord`` is an almost identical version of ``simple_history.models.HistoricalRecord``
        with the exception of two methods:  ``get_extra_fields()`` and ``add_extra_methods()``. Method 
        ``get_extra_fields()`` is overridden to change the ``history_id`` primary key from an 
        ``IntegerField`` to a ``UUIDField`` so that it can work with module ``django_collect_offline``.
        
        
        The audit trail models created by ``HistoricalRecord`` have a foreign key to ``auth.User``. In order for the models to work with `django_collect_offline` specify the django_collect_offline User model in settings:
            
        .. code-block:: python
        
            AUTH_USER_MODEL = 'django_collect_offline.User' 
        
        
        Notes
        -----
        
        User created and modified fields behave as follows:
        
        * created is only set on pre-save add
        * modified is always updated
        
        
        .. |pypi| image:: https://img.shields.io/pypi/v/edc-base.svg
            :target: https://pypi.python.org/pypi/edc-base
            
        .. |travis| image:: https://travis-ci.org/clinicedc/edc-base.svg?branch=develop
            :target: https://travis-ci.org/clinicedc/edc-base
            
        .. |coverage| image:: https://coveralls.io/repos/github/clinicedc/edc-facility/badge.svg?branch=develop
            :target: https://coveralls.io/github/clinicedc/edc-facility?branch=develop
            
        
Keywords: django base models fields forms admin
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
