django-curation 2.1.0

tox

Setup:

python3 -m venv venv
. venv/bin/activate
pip install tox

Run all tests:

tox

Run code coverage and render HTML report:

tox -e cov
open htmlcov/index.html

pytest

Setup:

python3 -m venv venv
. venv/bin/activate
pip install pytest pytest-cov pytest-django "Django<2.1"
pip install -e .

Run tests:

python -m pytest

Run code coverage and render HTML report:

python -m pytest --cov-report html --cov-report term --cov=curation

curation.models.CuratedItem

Abstract class representing an item in a curated group.

In order for a model that extends this class to proxy successfully, it must define a CuratedForeignKey field:

class CuratedPost(CuratedItem):
    post = curation.fields.CuratedForeignKey(Post)

field_overrides = {}

A dict that maps field names in the proxy model (the to=… model in the CuratedForeignKey) to field names in the current model which can override them (provided their value is not None or an empty string).

This takes the form:

field_overrides = {
     'title': 'custom_title',
     'status': 'custom_status',
}

Where custom_title and custom_status are fields in the model extending CuratedItem, and title and status are fields in the proxy model.

primary_id = models.AutoField(primary_key=True, db_column='id')

Custom primary key to prevent conflicts with the proxy model’s primary key.

curation.models.CuratedItemManager

A manager that defines queryset helpers for CuratedItem.

curation.base.CuratedItemModelBase

Overrides ModelBase to check whether a curation.fields.CuratedForeignKey is defined on the model. If not, throw a TypeError.

curation.fields.CuratedForeignKey

A ForeignKey that gets a list of the __dict__ keys and field names of the related model on load. It saves this list to the _proxy_attrs attribute of its parent model’s _meta attribute.