API Documentation

Here is the documentation of the complete API.

• djangofloor.admin
  • Admin models for created notifications
• djangofloor.backends
  • Miscelaneous backends
• djangofloor.celery
  • load Celery and discover tasks
• djangofloor.checks
  • Define checks integrated to the Django check framework
• djangofloor.conf.callables
  • Callables settings
• djangofloor.conf.config_values
  • Complex settings at runtime
• djangofloor.conf.defaults
  • Default values for all Django settings
• djangofloor.conf.fields
  • Convert values from config files to Python values
• djangofloor.conf.mapping
  • Mapping between .ini config files and Django settings
• djangofloor.conf.merger
  • Classes and functions used for the DjangoFloor settings system
• djangofloor.conf.providers
  • Providers of Django settings
• djangofloor.conf.settings
  • Classes and functions used for the DjangoFloor settings system
• djangofloor.context_processors
  • DjangoFloor’s specific context processors
• djangofloor.decorators
  • Decorators to declare signals and remote functions
• djangofloor.forms
  • Forms used in default views
• djangofloor.functions
  • Module with all default DjangoFloor WS functions
• djangofloor.log
  • Log utilities to improve Django logging
• djangofloor.middleware
  • HttpRequest and WindowInfo middlewares
• djangofloor.models
  • Django models specific to DjangoFloor
• djangofloor.root_urls
  • Root URLs provided by DjangoFloor
• djangofloor.scripts
  • “Main” functions for Django, Celery, Gunicorn and uWSGI
• djangofloor.signals
  • Module with all default DjangoFloor signals
• djangofloor.signals.bootstrap3
  • Python shortcuts for JS Bootstrap3 signals
• djangofloor.signals.html
  • Python shortcuts for JS signals
• djangofloor.tasks
  • Define Celery tasks and functions for calling signals
• djangofloor.templatetags.djangofloor
  • Templatetags for media files, websockets, notifications
• djangofloor.templatetags.pipeline
  • Emulate django-pipeline templatetags
• djangofloor.tests
• djangofloor.urls
  • URLs specific to DjangoFloor
• djangofloor.utils
  • Utility functions
• djangofloor.views
  • DjangoFloor utility views
• djangofloor.views.auth
  • Views related to user authentication
• djangofloor.views.monitoring
  • Display some system info
• djangofloor.views.search
  • Abstract global-site search view
• djangofloor.wsgi.aiohttp_runserver
• djangofloor.wsgi.django_runserver
• djangofloor.wsgi.exceptions
• djangofloor.wsgi.gunicorn_runserver
• djangofloor.wsgi.topics
  • Convert a websocket topic to a string
• djangofloor.wsgi.window_info
  • WindowInfo object and associated functions
• djangofloor.wsgi.wsgi_server