API Documentation

This section of the django-lass-people documentation is automatically generated from the code.

The people package

This package provides a model of a membership database for a student or community radio station, as well as the means to bind people to other models.

Models

people contains several models: models that define the person database, and models that form the credit system.

person

people.models.person contains models pertaining to people and various subtypes of people.

For the time being, it defines the structure of the URY membership database, which is a legacy hold-over and in need of some cleanup.

class people.models.person.Approver(*args, **kwargs)

Bases: people.models.person.Person

A person who has approved an item of data.

This class is currently a proxy to Person.

exception DoesNotExist

Bases: people.models.person.DoesNotExist

exception Approver.MultipleObjectsReturned

Bases: people.models.person.MultipleObjectsReturned

Approver.objects = <django.db.models.manager.Manager object at 0x30cff90>

class people.models.person.Creator(*args, **kwargs)

Bases: people.models.person.Person

A creator of data.

This class is currently a proxy to Person.

exception DoesNotExist

Bases: people.models.person.DoesNotExist

exception Creator.MultipleObjectsReturned

Bases: people.models.person.MultipleObjectsReturned

Creator.objects = <django.db.models.manager.Manager object at 0x30cf850>

class people.models.person.Person(*args, **kwargs)

Bases: django.db.models.base.Model

A person tracked by the URY people database.

A person, despite the name of the database table, is not necessarily a URY member. The people database also tracks:

• People who have left URY
• Honorary members
• People who have joined URY but not yet paid membership dues
• People who have signed up to join URY but have not yet done so

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Person.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Person.full_name()

Retrieves the full name of this person.

The full name is in the format FIRSTNAME LASTNAME, as per Western customs.

Person.full_name_reverse()

Retrieves the reverse-order full name of this person.

The result will be in the format LASTNAME, FIRSTNAME (with the comma).

Person.get_next_by_date_joined(*moreargs, **morekwargs)

Person.get_next_by_end_of_course(*moreargs, **morekwargs)

Person.get_next_by_last_login(*moreargs, **morekwargs)

Person.get_previous_by_date_joined(*moreargs, **morekwargs)

Person.get_previous_by_end_of_course(*moreargs, **morekwargs)

Person.get_previous_by_last_login(*moreargs, **morekwargs)

Person.objects = <django.db.models.manager.Manager object at 0x30cfa50>

credit

people.models.credit contains models concerning crediting people for having performed roles with regards to other models.

class people.models.credit.Credit(*args, **kwargs)

Bases: people.mixins.approvable.ApprovableMixin, people.mixins.creatable.CreatableMixin, lass_utils.mixins.effective_range.EffectiveRangeMixin

Abstract base class for credit models.

class Meta

Bases: lass_utils.mixins.effective_range.Meta

abstract = False

ordering = ['credit']

Credit.approver

Credit.creator

Credit.credit

Credit.credit_type

class people.models.credit.CreditType(*args, **kwargs)

Bases: django.db.models.base.Model

A type of credit, as used in ShowCredit.

Types of show credit might include “presenter”, “director”, “reporter” and so on.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception CreditType.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

CreditType.objects = <django.db.models.manager.Manager object at 0x41db250>