Ferrobase Package Overview
==========================

See the full API at :doc:`../api/ferrosoft.apps.ferrobase`.

Modules
-------

:mod:`~ferrosoft.apps.ferrobase.apps`
   .. automodule:: ferrosoft.apps.ferrobase.apps
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.consumers`
   .. automodule:: ferrosoft.apps.ferrobase.consumers
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.containers`
   .. automodule:: ferrosoft.apps.ferrobase.containers
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.context`
   .. automodule:: ferrosoft.apps.ferrobase.context
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.context_processors`
   .. automodule:: ferrosoft.apps.ferrobase.context_processors
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.encodings`
   .. automodule:: ferrosoft.apps.ferrobase.encodings
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.filter`
   .. automodule:: ferrosoft.apps.ferrobase.filter
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.frontend`
   .. automodule:: ferrosoft.apps.ferrobase.frontend
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templating`
   .. automodule:: ferrosoft.apps.ferrobase.templating
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.urls`
   .. automodule:: ferrosoft.apps.ferrobase.urls
      :noindex:
      :no-members:

Subpackages
-----------

ferrobase.api
~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.api
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.api`.

:mod:`~ferrosoft.apps.ferrobase.api.exception`
   .. automodule:: ferrosoft.apps.ferrobase.api.exception
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.api.router`
   .. automodule:: ferrosoft.apps.ferrobase.api.router
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.api.serializers`
   .. automodule:: ferrosoft.apps.ferrobase.api.serializers
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.api.views`
   .. automodule:: ferrosoft.apps.ferrobase.api.views
      :noindex:
      :no-members:

ferrobase.auth
~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.auth
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.auth`.

:mod:`~ferrosoft.apps.ferrobase.auth.roles`
   .. automodule:: ferrosoft.apps.ferrobase.auth.roles
      :noindex:
      :no-members:

ferrobase.forms
~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.forms
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.forms`.

:mod:`~ferrosoft.apps.ferrobase.forms.copy`
   .. automodule:: ferrosoft.apps.ferrobase.forms.copy
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.forms.fields`
   .. automodule:: ferrosoft.apps.ferrobase.forms.fields
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.forms.model_forms`
   .. automodule:: ferrosoft.apps.ferrobase.forms.model_forms
      :noindex:
      :no-members:

ferrobase.management
~~~~~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.management
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.management`.

ferrobase.middleware
~~~~~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.middleware
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.middleware`.

:mod:`~ferrosoft.apps.ferrobase.middleware.appmeta`
   .. automodule:: ferrosoft.apps.ferrobase.middleware.appmeta
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.middleware.asgi`
   .. automodule:: ferrosoft.apps.ferrobase.middleware.asgi
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.middleware.cache`
   .. automodule:: ferrosoft.apps.ferrobase.middleware.cache
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.middleware.language`
   .. automodule:: ferrosoft.apps.ferrobase.middleware.language
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.middleware.tenant`
   .. automodule:: ferrosoft.apps.ferrobase.middleware.tenant
      :noindex:
      :no-members:

ferrobase.models
~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.models
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.models`.

:mod:`~ferrosoft.apps.ferrobase.models.base`
   .. automodule:: ferrosoft.apps.ferrobase.models.base
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.builtin`
   .. automodule:: ferrosoft.apps.ferrobase.models.builtin
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.decimal`
   .. automodule:: ferrosoft.apps.ferrobase.models.decimal
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.fields`
   .. automodule:: ferrosoft.apps.ferrobase.models.fields
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.file`
   .. automodule:: ferrosoft.apps.ferrobase.models.file
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.identity`
   .. automodule:: ferrosoft.apps.ferrobase.models.identity
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.registry`
   .. automodule:: ferrosoft.apps.ferrobase.models.registry
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.shared`
   .. automodule:: ferrosoft.apps.ferrobase.models.shared
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.subscription`
   .. automodule:: ferrosoft.apps.ferrobase.models.subscription
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.models.units`
   .. automodule:: ferrosoft.apps.ferrobase.models.units
      :noindex:
      :no-members:

ferrobase.services
~~~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.services
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.services`.

:mod:`~ferrosoft.apps.ferrobase.services.captcha`
   .. automodule:: ferrosoft.apps.ferrobase.services.captcha
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.cleanup`
   .. automodule:: ferrosoft.apps.ferrobase.services.cleanup
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.conversion`
   .. automodule:: ferrosoft.apps.ferrobase.services.conversion
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.help`
   .. automodule:: ferrosoft.apps.ferrobase.services.help
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.idgenerator`
   .. automodule:: ferrosoft.apps.ferrobase.services.idgenerator
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.onboarding`
   .. automodule:: ferrosoft.apps.ferrobase.services.onboarding
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.sse`
   .. automodule:: ferrosoft.apps.ferrobase.services.sse
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.static_files`
   .. automodule:: ferrosoft.apps.ferrobase.services.static_files
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.taskqueue`
   .. automodule:: ferrosoft.apps.ferrobase.services.taskqueue
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.tenant_mgm`
   .. automodule:: ferrosoft.apps.ferrobase.services.tenant_mgm
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.update`
   .. automodule:: ferrosoft.apps.ferrobase.services.update
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.user_mgm`
   .. automodule:: ferrosoft.apps.ferrobase.services.user_mgm
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.services.zitadel`
   .. automodule:: ferrosoft.apps.ferrobase.services.zitadel
      :noindex:
      :no-members:

ferrobase.session
~~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.session
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.session`.

:mod:`~ferrosoft.apps.ferrobase.session.forms`
   .. automodule:: ferrosoft.apps.ferrobase.session.forms
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.session.password_reset`
   .. automodule:: ferrosoft.apps.ferrobase.session.password_reset
      :noindex:
      :no-members:

ferrobase.tables
~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.tables
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.tables`.

:mod:`~ferrosoft.apps.ferrobase.tables.columns`
   .. automodule:: ferrosoft.apps.ferrobase.tables.columns
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.tables.crud`
   .. automodule:: ferrosoft.apps.ferrobase.tables.crud
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.tables.models`
   .. automodule:: ferrosoft.apps.ferrobase.tables.models
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.tables.table`
   .. automodule:: ferrosoft.apps.ferrobase.tables.table
      :noindex:
      :no-members:

ferrobase.templatetags
~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.templatetags
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.templatetags`.

:mod:`~ferrosoft.apps.ferrobase.templatetags.ajax`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.ajax
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.bootstrap5`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.bootstrap5
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.datetime`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.datetime
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.decimal`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.decimal
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.ferrobase`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.ferrobase
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.ferrobase_files`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.ferrobase_files
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.ferrobase_menu`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.ferrobase_menu
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.foundation`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.foundation
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.iam`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.iam
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.labels`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.labels
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.templatetags.tables`
   .. automodule:: ferrosoft.apps.ferrobase.templatetags.tables
      :noindex:
      :no-members:

ferrobase.tenant
~~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.tenant
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.tenant`.

:mod:`~ferrosoft.apps.ferrobase.tenant.context`
   .. automodule:: ferrosoft.apps.ferrobase.tenant.context
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.tenant.forms`
   .. automodule:: ferrosoft.apps.ferrobase.tenant.forms
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.tenant.tables`
   .. automodule:: ferrosoft.apps.ferrobase.tenant.tables
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.tenant.utils`
   .. automodule:: ferrosoft.apps.ferrobase.tenant.utils
      :noindex:
      :no-members:

ferrobase.views
~~~~~~~~~~~~~~~

.. automodule:: ferrosoft.apps.ferrobase.views
   :noindex:
   :no-members:

Detail page: :doc:`../api/ferrosoft.apps.ferrobase.views`.

:mod:`~ferrosoft.apps.ferrobase.views.api_token`
   .. automodule:: ferrosoft.apps.ferrobase.views.api_token
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.base`
   .. automodule:: ferrosoft.apps.ferrobase.views.base
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.company_site`
   .. automodule:: ferrosoft.apps.ferrobase.views.company_site
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.files`
   .. automodule:: ferrosoft.apps.ferrobase.views.files
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.generic`
   .. automodule:: ferrosoft.apps.ferrobase.views.generic
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.group`
   .. automodule:: ferrosoft.apps.ferrobase.views.group
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.index`
   .. automodule:: ferrosoft.apps.ferrobase.views.index
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.material`
   .. automodule:: ferrosoft.apps.ferrobase.views.material
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.media`
   .. automodule:: ferrosoft.apps.ferrobase.views.media
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.onboarding`
   .. automodule:: ferrosoft.apps.ferrobase.views.onboarding
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.organization`
   .. automodule:: ferrosoft.apps.ferrobase.views.organization
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.partner`
   .. automodule:: ferrosoft.apps.ferrobase.views.partner
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.password`
   .. automodule:: ferrosoft.apps.ferrobase.views.password
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.session`
   .. automodule:: ferrosoft.apps.ferrobase.views.session
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.settings`
   .. automodule:: ferrosoft.apps.ferrobase.views.settings
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.tenant`
   .. automodule:: ferrosoft.apps.ferrobase.views.tenant
      :noindex:
      :no-members:

:mod:`~ferrosoft.apps.ferrobase.views.user`
   .. automodule:: ferrosoft.apps.ferrobase.views.user
      :noindex:
      :no-members: