django-genomix 0.6.9

Core library for Nexus django projects

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:

INSTALLED_APPS = (
    ...
    'genomix',
    ...
)

Features

1. DisplayChoiceField - display representation values for choice fields in REST APIs.:

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.:

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.:

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.:

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

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)

0.2.0 Changelog

• 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)

0.3.0 Changelog

• DisplayChoiceFilter for use in django_filters. Filter by diplay fields for a choice field in a REST API

0.4.0 (2018-01-05)

0.4.0 Changelog

• Improved docs

• Beta release

0.4.1 (2018-01-09)

0.4.1 Changelog

• DisplayChoiceFilter fixed coerce method to handle Choices with different display values.

0.5.0 (2018-02-09)

0.5.0 Changelog

• Updated requirements to the latest.

0.6.0 (2018-04-07)

0.6.0 Changelog

• Added support for Django 2.0 and Python3.6

• Dropped support for Django <1.11 and Python 2.7, 3.3, 3.4

0.6.1 (2018-04-18)

0.6.1 Changelog

• Upgraded 3rd party libs

0.6.2 (2018-05-16)

0.6.2 Changelog

• Updated setup.py to read install_requires from requirements.txt

0.6.3 (2018-08-13)

0.6.3 Changelog

• Updated 3rd party requirements. Some requirements had changed so it was causing failures

0.6.4 (2018-10-29)

0.6.4 Changelog

• Updated deps and adjusted for new flake8 reqs

0.6.5 (2019-02-07)

0.6.5 Changelog

• Updated deps

0.6.6 (2019-04-10)

0.6.6 Changelog

• Updated deps

• Updated travis to use xenial distribution. Django 2.1 dropped support for SQLite < 3.8.3

0.6.7 (2019-05-30)

0.6.7 Changelog

• Updated deps

0.6.8 (2019-07-26)

0.6.8 Changelog

• Updated deps

0.6.9 (2019-08-09)

0.6.9 Changelog

• Updated deps