Skip to content

Latest commit

 

History

History
174 lines (114 loc) · 4.44 KB

technical_doc_part_2.rst

File metadata and controls

174 lines (114 loc) · 4.44 KB
Raw

Technical documentation: Core modules

accounts

Accounts module is responsible for extending the :py:class:`django.contrib.auth.models.User` model. It provides a :class:`trapper.apps.accounts.models.UserProfile` model which extends some basic user functionality.

models

.. automodule:: trapper.apps.accounts.models
    :members:

views

.. automodule:: trapper.apps.accounts.views
    :members:

forms

.. automodule:: trapper.apps.accounts.forms
    :members:

storage

Purpose of storage module is uploading and storing various media resources. In most cases this will be video files, images or audio files, but any type of file can be uploaded and stored. It is often used by other applications (e.g. :mod:`trapper.apps.media_classification`) to display media resources.

models

.. automodule:: trapper.apps.storage.models
    :members:

views

.. automodule:: trapper.apps.storage.views
    :members:

forms

.. automodule:: trapper.apps.storage.forms
    :members:

media_classification

Media classification module is at the moment one of the core features of Trapper. This module allows for the classification of media resources (:ref:`trapper.apps.storage`) within the context defined in :class:`trapper.apps.media_classification.models.Project` objects.

Note

It is worth noting how the classification is handled in the backend: Single Classification is split into rows, each containing an indentical set of features. Each ClassificationRow is again split into a set of states of the Feature model, namely an instance of model FeatureAnswer

See models for more details:

models

.. automodule:: trapper.apps.media_classification.models
    :members:

views

.. automodule:: trapper.apps.media_classification.views
    :members:

forms

.. automodule:: trapper.apps.media_classification.forms
    :members:

decorators

.. automodule:: trapper.apps.media_classification.decorators
    :members:

messaging

Module :ref:`trapper.apps.messaging` serves as a simple notification system as well as an internal e-mail functionality between the users.

models

.. automodule:: trapper.apps.messaging.models
    :members:

views

.. automodule:: trapper.apps.messaging.views
    :members:

forms

.. automodule:: trapper.apps.messaging.forms
    :members:

geomap

Module :ref:`trapper.apps.geomap` uses geospatial information about resources stored by :ref:`trapper.apps.storage` to present it on the map.

models

.. automodule:: trapper.apps.geomap.models
    :members:

views

.. automodule:: trapper.apps.geomap.views
    :members:

forms

.. automodule:: trapper.apps.geomap.forms
    :members:

common

Module :ref:`trapper.apps.common` servers as a place for a general-purpose functions or decorators, not associated with any of the applications above.

decorators

.. automodule:: trapper.apps.common.decorators
    :members: