.. auto generated by export_reference.py
****
Core
****
|development| |app|
**Version:** 4.0.0-d
**Dependencies**
- `bandit `_ (required) *Used to scan SuperDjango for security issues.*
- `semver `_ (required) *Used for version management and generating documentation.*
.. _core-assets-developer:
Assets
======
|development| |app|
Provides access to static files for all other SuperDjango apps and includes resources for programmatically defining JavaScript and CSS.
Component Reference: :ref:`core-assets`
library
-------
.. automodule:: superdjango.assets.library
:members:
:show-inheritance:
:special-members: __init__
.. _core-conf-developer:
Conf
====
|development| |configuration|
Manage settings for SuperDjango.
Component Reference: :ref:`core-conf`
.. automodule:: superdjango.conf
:members:
:show-inheritance:
:special-members: __init__
.. _core-context_processors-developer:
Context Processors
==================
|alpha| |app|
Commonly needed processing that doesn't necessarily fit within a specific app.
Component Reference: :ref:`core-context_processors`
.. automodule:: superdjango.context_processors
:members:
:show-inheritance:
:special-members: __init__
.. _core-constants-developer:
Constants
=========
|development| |configuration|
Constants that may be used across SuperDjango and (optionally) your project.
Component Reference: :ref:`core-constants`
.. automodule:: superdjango.constants
:members:
:show-inheritance:
:special-members: __init__
.. _core-forms-developer:
Forms
=====
|development| |library|
Forms, fields, and widgets used across SuperDjango.
Component Reference: :ref:`core-forms`
fields
------
.. automodule:: superdjango.forms.fields
:members:
:show-inheritance:
:special-members: __init__
forms
-----
.. automodule:: superdjango.forms.forms
:members:
:show-inheritance:
:special-members: __init__
widgets
-------
.. automodule:: superdjango.forms.widgets
:members:
:show-inheritance:
:special-members: __init__
.. _core-env-developer:
Environment
===========
|experimental| |configuration|
Load configuration variables from an INI file.
Component Reference: :ref:`core-env`
library
-------
.. automodule:: superdjango.env.library
:members:
:show-inheritance:
:special-members: __init__
.. _core-exceptions-developer:
Exceptions
==========
|development| |library|
Exceptions for speed, convenience, and humor.
Component Reference: :ref:`core-exceptions`
.. automodule:: superdjango.exceptions
:members:
:show-inheritance:
:special-members: __init__
.. _core-html-developer:
HTML
====
|development| |app|
An app providing resources for working with HTML in a reasonably abstract manner.
Component Reference: :ref:`core-html`
bootstrap4
----------
.. automodule:: superdjango.html.frameworks.bootstrap4
:members:
:show-inheritance:
:special-members: __init__
foundation6
-----------
.. automodule:: superdjango.html.frameworks.foundation6
:members:
:show-inheritance:
:special-members: __init__
uikit3
------
.. automodule:: superdjango.html.frameworks.uikit3
:members:
:show-inheritance:
:special-members: __init__
library
-------
.. automodule:: superdjango.html.library
:members:
:show-inheritance:
:special-members: __init__
templatetags
------------
.. automodule:: superdjango.html.templatetags
:members:
:show-inheritance:
:special-members: __init__
shortcuts
---------
.. automodule:: superdjango.html.shortcuts
:members:
:show-inheritance:
:special-members: __init__
utils
-----
.. automodule:: superdjango.html.utils
:members:
:show-inheritance:
:special-members: __init__
.. _core-patterns-developer:
Patterns
========
|development| |configuration|
Utilities and backends for file storage.
Component Reference: :ref:`core-patterns`
constants
---------
.. automodule:: superdjango.patterns.constants
:members:
:show-inheritance:
:special-members: __init__
converters
----------
.. automodule:: superdjango.patterns.converters
:members:
:show-inheritance:
:special-members: __init__
library
-------
.. automodule:: superdjango.patterns.library
:members:
:show-inheritance:
:special-members: __init__
.. _core-sessions-developer:
Sessions
========
|experimental| |interface|
Work with Django sessions using an object-oriented interface.
Component Reference: :ref:`core-sessions`
library
-------
.. automodule:: superdjango.sessions.library
:members:
:show-inheritance:
:special-members: __init__
.. _core-shortcuts-developer:
Shortcuts
=========
|development| |library|
A library of functions and classes that span Django's MVT framework.
Component Reference: :ref:`core-shortcuts`
library
-------
.. automodule:: superdjango.shortcuts.library
:members:
:show-inheritance:
:special-members: __init__
.. _core-storage-developer:
Storage
=======
|development| |library|
Utilities and backends for file storage.
Component Reference: :ref:`core-storage`
ajax
----
.. automodule:: superdjango.storage.backends.ajax
:members:
:show-inheritance:
:special-members: __init__
overwrite
---------
.. automodule:: superdjango.storage.backends.overwrite
:members:
:show-inheritance:
:special-members: __init__
constants
---------
.. automodule:: superdjango.storage.constants
:members:
:show-inheritance:
:special-members: __init__
receivers
---------
.. automodule:: superdjango.storage.receivers
:members:
:show-inheritance:
:special-members: __init__
signals
-------
.. automodule:: superdjango.storage.signals
:members:
:show-inheritance:
:special-members: __init__
utils
-----
.. automodule:: superdjango.storage.utils
:members:
:show-inheritance:
:special-members: __init__
.. _core-utils-developer:
Utilities
=========
|development| |library|
General utilities not necessarily related to Django but nevertheless use for general operation.
Component Reference: :ref:`core-utils`
constants
---------
.. automodule:: superdjango.utils.constants
:members:
:show-inheritance:
:special-members: __init__
library
-------
.. automodule:: superdjango.utils.library
:members:
:show-inheritance:
:special-members: __init__
.. _core-views-developer:
Views
=====
|development| |library|
High-level, class-based views that may be used in practically all of the common use cases for Web application development.
Component Reference: :ref:`core-views`
access
------
.. automodule:: superdjango.views.access
:members:
:show-inheritance:
:special-members: __init__
ajax
----
.. automodule:: superdjango.views.ajax
:members:
:show-inheritance:
:special-members: __init__
base
----
.. automodule:: superdjango.views.base
:members:
:show-inheritance:
:special-members: __init__
breadcrumbs
-----------
.. automodule:: superdjango.views.breadcrumbs
:members:
:show-inheritance:
:special-members: __init__
crud
----
.. automodule:: superdjango.views.crud
:members:
:show-inheritance:
:special-members: __init__
forms
-----
.. automodule:: superdjango.views.forms
:members:
:show-inheritance:
:special-members: __init__
images
------
.. automodule:: superdjango.views.images
:members:
:show-inheritance:
:special-members: __init__
messages
--------
.. automodule:: superdjango.views.messages
:members:
:show-inheritance:
:special-members: __init__
redirects
---------
.. automodule:: superdjango.views.redirects
:members:
:show-inheritance:
:special-members: __init__
templates
---------
.. automodule:: superdjango.views.templates
:members:
:show-inheritance:
:special-members: __init__
viewsets
--------
.. automodule:: superdjango.views.viewsets
:members:
:show-inheritance:
:special-members: __init__