web_reflectivity package

Submodules

web_reflectivity.settings module

The settings are split into difference ones directed at particular usage. They can be controlled using the DJANGO_SETTINGS_MODULE environment variable. Each settings module makes some small changes based on particular runtime environments. More information on django settings can be found at the django documentation site.

  • web_reflectivity.settings.base which is, generally, the super-set of all other settings. This should never be assigned to DJANGO_SETTINGS_MODULE.

  • web_reflectivity.settings.unittest is used for running the unit tests and while building the sphinx site

  • web_reflectivity.settings.develop is used for development

  • web_reflectivity.settings.envtest is used for remote test environment

  • web_reflectivity.settings.prod is used for production environment

General settings

SECRET_KEY: str="UNSET_SECRET"

Taken from the environment variable APP_SECRET

INSTALLATION_DIR: str="/var/www/"

Taken from the environment variable REFL_INSTALL_DIR and converted to a pathlib.Path

DEBUG: bool

This is True for all settings except web_reflectivity.settings.prod.

Settings for LDAP

LDAP_DOMAIN_COMPONENT: str

Taken from the environment variable LDAP_DOMAIN_COMPONENT

AUTH_LDAP_SERVER_URI: str

Taken from the environment variable LDAP_SERVER_URI

AUTH_LDAP_CERT_FILE: str

Taken from the environment variable LDAP_CERT_FILE. Failing to specify this results in not verifying certificates for the LDAP connection.

Settings for database

These are ignored for web_reflectivity.settings.unittest which is hard coded for sqlite3.

DATABASES: dict

There are 5 environment variables that are used for configuring the database connection. Failing to specify any of these will result in a mis-configured system. The environment variables are DATABASE_NAME, DATABASE_USER, DATABASE_PASS, DATABASE_HOST, and DATABASE_PORT.

Settings for live data server

LIVE_DATA_SERVER: str

Taken from the environment variable LIVE_DATA_SERVER

LIVE_DATA_SERVER_DOMAIN: str

Taken from the environment variable LIVE_DATA_SERVER_DOMAIN

LIVE_DATA_SERVER_PORT:: int

Taken from the environment variable LIVE_DATA_SERVER_PORT

LIVE_PLOT_SECRET_KEY: str

Taken from the environment variable LIVE_PLOT_SECRET_KEY

LIVE_DATA_API_USER: str

Taken from the environment variable LIVE_DATA_API_USER

LIVE_DATA_API_PWD: str

Taken from the environment variable LIVE_DATA_API_PWD

LIVE_DATA_USER_UPLOAD_URL: str

Taken from the environment variable LIVE_DATA_USER_UPLOAD_URL

LIVE_DATA_USER_FILES_URL: str

Taken from the environment variable LIVE_DATA_USER_FILES_URL

Settings for fitting server

REFL1D_JOB_DIR: str="/tmp"

Taken from the environment variable REFL1D_JOB_DIR and converted to a pathlib.Path

JOB_HANDLING_HOST: str="localhost"

Taken from the environment variable JOB_HANDLING_HOST

JOB_HANDLING_PORT: int=22

Taken from the environment variable JOB_HANDLING_PORT

JOB_HANDLING_INTERPRETER: str="python"

Taken from the environment variable JOB_HANDLING_INTERPRETER

Settings for OnCAT

CATALOG_URL: str

Taken from the environment variable CATALOG_URL

CATALOG_ID: str

Taken from the environment variable CATALOG_ID

CATALOG_SECRET: str

Taken from the environment variable CATALOG_SECRET

Settings for local development

Local development uses a specific local worker which needs a user configured.

TEST_REMOTE_USER: str

Taken from the environment variable TEST_USER_NAME

TEST_REMOTE_PASSWD: str

Taken from the environment variable TEST_USER_PASSWD

web_reflectivity.routing module

Not currently documented

web_reflectivity.urls module

Not currently documented

web_reflectivity.wsgi module

WSGI config for web_reflectivity project.

It exposes the WSGI callable as a module-level variable named application.

For more information on this file, see https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/