Devilry developer documentation

Note

Welcome to the Devilry developer documentation. See http://devilry.org/ for general information about Devilry, and https://github.com/devilry/devilry-django for the code.

Essentials

• Setup a local development environment
• The devilry testsuite
• Mocking tests
• corebuilder — Setup devilry core data structures for tests

Essential wiki pages for developers

• How to write API documentation - wiki page
• More info available on the Developer wiki page.

API and utilities

• devilry.apps.core.models — Devilry core datastructure
• The Devilry User object
• devilry.apps.core.deliverystore — DeliveryStore
• devilry.utils — Various utility functions

Advanced topics

Most developers will not need to bother with these topics.

• Developing and testing Celery background tasks
• How to write a plugin
• Devilry localization/internationalization/translation
• Configure Transifex
• JavaScript — Libraries and guidelines/code style

Apps

• devilry_subjectadmin — Subject administrator GUI
• devilry_qualifiesforexam
• devilry_gradingsystem — The devilry grading system plugin architecture
• devilry.devilry_search — Search for Devilry
• devilry.devilry_theme — The Devilry theme

Deprecated APIs and frameworks

• devilry.apps.core.testhelper — Create core test data

Releases

• Release notes
• How to release a new Devilry version