Metadata-Version: 1.1
Name: django-genomix
Version: 0.4.1
Summary: Core library for Nexus django projects
Home-page: https://github.com/genomics-geek/django-genomix
Author: Michael A. Gonzalez
Author-email: genomics.geek.04.22@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: =============================
        Django GenomiX
        =============================
        
        .. image:: https://badge.fury.io/py/django-genomix.svg
            :target: https://badge.fury.io/py/django-genomix
        
        .. image:: https://travis-ci.org/chopdgd/django-genomix.svg?branch=develop
            :target: https://travis-ci.org/chopdgd/django-genomix
        
        .. image:: https://codecov.io/gh/chopdgd/django-genomix/branch/develop/graph/badge.svg
            :target: https://codecov.io/gh/chopdgd/django-genomix
        
        .. image:: https://pyup.io/repos/github/chopdgd/django-genomix/shield.svg
             :target: https://pyup.io/repos/github/chopdgd/django-genomix/
             :alt: Updates
        
        .. image:: https://pyup.io/repos/github/chopdgd/django-genomix/python-3-shield.svg
              :target: https://pyup.io/repos/github/chopdgd/django-genomix/
              :alt: Python 3
        
        Core library for Nexus django projects
        
        Documentation
        -------------
        
        The full documentation is at https://django-genomix.readthedocs.io.
        
        Quickstart
        ----------
        
        Install Django GenomiX::
        
            pip install django-genomix
        
        Add it to your `INSTALLED_APPS`:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'genomix',
                ...
            )
        
        
        Features
        --------
        
        1. DisplayChoiceField - display representation values for choice fields in REST APIs.::
        
        .. code-block:: python
        
            from genomix.fields import DisplayChoiceField
            from rest_framework import serializers
        
            from . import choices
        
        
            class ExampleSerializer(serializers.ModelSerializer):
        
                status = DisplayChoiceField(choices=choices.STATUS_OPTIONS)
        
        2. UserRelatedField - display username for a REST API with a user relation.::
        
        .. code-block:: python
            from django.contrib.auth import get_user_model
        
            from genomix.fields import UserRelatedField
            from rest_framework import serializers
        
        
            class ExampleSerializer(serializers.ModelSerializer):
        
                user = UserRelatedField(queryset=get_user_model().objects.all())
        
        
        3. ContentRelatedField - display ContentType model for a REST API using a generic relation.::
        
        .. code-block:: python
            from django.contrib.auth import get_user_model
            from django.contrib.contenttypes.models import ContentType
        
            from genomix.fields import ContentRelatedField
            from rest_framework import serializers
        
        
            class ExampleSerializer(serializers.ModelSerializer):
        
                content_type = ContentRelatedField(queryset=ContentType.objects.all())
        
        4. DisplayChoiceFilter - Filter by representation values in a REST API.::
        
        .. code-block:: python
        
            import django_filters
            from genomix.filters import DisplayChoiceFilter
        
            from . import choices
        
        
            class ExampleFilter(django_filters.rest_framework.FilterSet):
        
                source = DisplayChoiceFilter(choices=choices.SOURCES)
        
        Running Tests
        -------------
        
        Does the code actually work?
        
        ::
        
            source <YOURVIRTUALENV>/bin/activate
            (myenv) $ pip install tox
            (myenv) $ tox
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `cookiecutter-djangopackage`_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
        
        
        
        
        History
        -------
        
        0.1.0 (2017-12-02)
        ++++++++++++++++++
        
        * First release on PyPI.
        * TimeStampedLabelModel abstract model class
        * UserRelatedField for use in DRF serializers
        * DisplayChoiceField for use in DRF serializers
        * ContentRelatedField for use in DRF serializers
        * DefaultRouter that allows you to extend other routers
        * ModelMixinTestCase that allows you to test abstract model classes
        
        0.2.0 (2017-12-31)
        ++++++++++++++++++
        
        * Added utils function to retrieve data from a URL
        * Added utils function to retrieve compressed data from a URL
        
        0.3.0 (2018-01-04)
        ++++++++++++++++++
        
        * DisplayChoiceFilter for use in django_filters. Filter by diplay fields for a choice field in a REST API
        
        0.4.0 (2018-01-05)
        ++++++++++++++++++
        
        * Improved docs
        * Beta release
        
        0.4.1 (2018-01-09)
        ++++++++++++++++++
        
        * DisplayChoiceFilter fixed coerce method to handle Choices with different display values.
        
Keywords: django-genomix
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
