marsha package

Subpackages

• marsha.core package
  • Subpackages
    • marsha.core.migrations package
      • Submodules
      • marsha.core.migrations.0001_initial_models module
      • marsha.core.migrations.0002_soft_deletion module
      • marsha.core.migrations.0003_missing_text_fields module
      • marsha.core.migrations.0004_duplicated_from__blank module
      • marsha.core.migrations.0005_use_our__nondeleteduniqueindex module
      • Module contents
    • marsha.core.tests package
      • Submodules
      • marsha.core.tests.factories module
      • marsha.core.tests.test_models module
      • Module contents
  • Submodules
  • marsha.core.admin module
  • marsha.core.apps module
  • marsha.core.base_models module
  • marsha.core.managers module
  • marsha.core.models module
  • marsha.core.views module
  • Module contents

Submodules

marsha.settings module

Django settings for marsha project.

Uses django-configurations to manage environments inheritance and the loading of some config from the environment

class marsha.settings.Base

Bases: configurations.base.Configuration

Base configuration every configuration (aka environment) should inherit from.

It depends on an environment variable that SHOULD be defined: - DJANGO_SECRET_KEY

You may also want to override default configuration by setting the following environment variables: - DJANGO_DEBUG - DATABASE_URL

ABSOLUTE_URL_OVERRIDES = {}

ADMINS = []

ALLOWED_HOSTS = []

APPEND_SLASH = True

AUTHENTICATION_BACKENDS = ['django.contrib.auth.backends.ModelBackend']

AUTH_PASSWORD_VALIDATORS = [{'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator'}, {'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator'}, {'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator'}, {'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator'}]

AUTH_USER_MODEL = 'core.User'

BASE_DIR = '/home/docs/checkouts/readthedocs.org/user_builds/marsha/envs/latest/lib/python3.6/site-packages/marsha'

CACHES = {'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}}

CACHE_MIDDLEWARE_ALIAS = 'default'

CACHE_MIDDLEWARE_KEY_PREFIX = ''

CACHE_MIDDLEWARE_SECONDS = 600

CSRF_COOKIE_AGE = 31449600

CSRF_COOKIE_DOMAIN = None

CSRF_COOKIE_HTTPONLY = False

CSRF_COOKIE_NAME = 'csrftoken'

CSRF_COOKIE_PATH = '/'

CSRF_COOKIE_SECURE = False

CSRF_FAILURE_VIEW = 'django.views.csrf.csrf_failure'

CSRF_HEADER_NAME = 'HTTP_X_CSRFTOKEN'

CSRF_TRUSTED_ORIGINS = []

CSRF_USE_SESSIONS = False

DATABASES = {}

DATABASE_ROUTERS = []

DATA_UPLOAD_MAX_MEMORY_SIZE = 2621440

DATA_UPLOAD_MAX_NUMBER_FIELDS = 1000

DATETIME_FORMAT = 'N j, Y, P'

DATETIME_INPUT_FORMATS = ['%Y-%m-%d %H:%M:%S', '%Y-%m-%d %H:%M:%S.%f', '%Y-%m-%d %H:%M', '%Y-%m-%d', '%m/%d/%Y %H:%M:%S', '%m/%d/%Y %H:%M:%S.%f', '%m/%d/%Y %H:%M', '%m/%d/%Y', '%m/%d/%y %H:%M:%S', '%m/%d/%y %H:%M:%S.%f', '%m/%d/%y %H:%M', '%m/%d/%y']

DATE_FORMAT = 'N j, Y'

DATE_INPUT_FORMATS = ['%Y-%m-%d', '%m/%d/%Y', '%m/%d/%y', '%b %d %Y', '%b %d, %Y', '%d %b %Y', '%d %b, %Y', '%B %d %Y', '%B %d, %Y', '%d %B %Y', '%d %B, %Y']

DEBUG = False

DEBUG_PROPAGATE_EXCEPTIONS = False

DECIMAL_SEPARATOR = '.'

DEFAULT_CHARSET = 'utf-8'

DEFAULT_CONTENT_TYPE = 'text/html'

DEFAULT_EXCEPTION_REPORTER_FILTER = 'django.views.debug.SafeExceptionReporterFilter'

DEFAULT_FILE_STORAGE = 'django.core.files.storage.FileSystemStorage'

DEFAULT_FROM_EMAIL = 'webmaster@localhost'

DEFAULT_INDEX_TABLESPACE = ''

DEFAULT_TABLESPACE = ''

DISALLOWED_USER_AGENTS = []

DOTENV_LOADED = None

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

EMAIL_HOST = 'localhost'

EMAIL_HOST_PASSWORD = ''

EMAIL_HOST_USER = ''

EMAIL_PORT = 25

EMAIL_SSL_CERTFILE = None

EMAIL_SSL_KEYFILE = None

EMAIL_SUBJECT_PREFIX = '[Django] '

EMAIL_TIMEOUT = None

EMAIL_USE_LOCALTIME = False

EMAIL_USE_SSL = False

EMAIL_USE_TLS = False

FILE_CHARSET = 'utf-8'

FILE_UPLOAD_DIRECTORY_PERMISSIONS = None

FILE_UPLOAD_HANDLERS = ['django.core.files.uploadhandler.MemoryFileUploadHandler', 'django.core.files.uploadhandler.TemporaryFileUploadHandler']

FILE_UPLOAD_MAX_MEMORY_SIZE = 2621440

FILE_UPLOAD_PERMISSIONS = None

FILE_UPLOAD_TEMP_DIR = None

FIRST_DAY_OF_WEEK = 0

FIXTURE_DIRS = []

FORCE_SCRIPT_NAME = None

FORMAT_MODULE_PATH = None

FORM_RENDERER = 'django.forms.renderers.DjangoTemplates'

IGNORABLE_404_URLS = []

INSTALLED_APPS = ['django.contrib.admin.apps.SimpleAdminConfig', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'django_extensions', 'marsha.core.apps.CoreConfig']

INTERNAL_IPS = []

LANGUAGES = [('en', 'english'), ('fr', 'french')]

LANGUAGES_BIDI = ['he', 'ar', 'fa', 'ur']

LANGUAGE_CODE = 'en-us'

LANGUAGE_COOKIE_AGE = None

LANGUAGE_COOKIE_DOMAIN = None

LANGUAGE_COOKIE_NAME = 'django_language'

LANGUAGE_COOKIE_PATH = '/'

LOCALE_PATHS = []

LOGGING = {}

LOGGING_CONFIG = 'logging.config.dictConfig'

LOGIN_REDIRECT_URL = '/accounts/profile/'

LOGIN_URL = '/accounts/login/'

LOGOUT_REDIRECT_URL = None

MANAGERS = []

MEDIA_ROOT = ''

MEDIA_URL = ''

MESSAGE_STORAGE = 'django.contrib.messages.storage.fallback.FallbackStorage'

MIDDLEWARE = ['django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware']

MIGRATION_MODULES = {}

MONTH_DAY_FORMAT = 'F j'

NUMBER_GROUPING = 0

PASSWORD_HASHERS = ['django.contrib.auth.hashers.PBKDF2PasswordHasher', 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher', 'django.contrib.auth.hashers.Argon2PasswordHasher', 'django.contrib.auth.hashers.BCryptSHA256PasswordHasher', 'django.contrib.auth.hashers.BCryptPasswordHasher']

PASSWORD_RESET_TIMEOUT_DAYS = 3

PREPEND_WWW = False

ROOT_URLCONF = 'marsha.urls'

SECRET_KEY = 'FooBar'

SECURE_BROWSER_XSS_FILTER = False

SECURE_CONTENT_TYPE_NOSNIFF = False

SECURE_HSTS_INCLUDE_SUBDOMAINS = False

SECURE_HSTS_PRELOAD = False

SECURE_HSTS_SECONDS = 0

SECURE_PROXY_SSL_HEADER = None

SECURE_REDIRECT_EXEMPT = []

SECURE_SSL_HOST = None

SECURE_SSL_REDIRECT = False

SERVER_EMAIL = 'root@localhost'

SESSION_CACHE_ALIAS = 'default'

SESSION_COOKIE_AGE = 1209600

SESSION_COOKIE_DOMAIN = None

SESSION_COOKIE_HTTPONLY = True

SESSION_COOKIE_NAME = 'sessionid'

SESSION_COOKIE_PATH = '/'

SESSION_COOKIE_SECURE = False

SESSION_ENGINE = 'django.contrib.sessions.backends.db'

SESSION_EXPIRE_AT_BROWSER_CLOSE = False

SESSION_FILE_PATH = None

SESSION_SAVE_EVERY_REQUEST = False

SESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'

SHORT_DATETIME_FORMAT = 'm/d/Y P'

SHORT_DATE_FORMAT = 'm/d/Y'

SIGNING_BACKEND = 'django.core.signing.TimestampSigner'

SILENCED_SYSTEM_CHECKS = []

STATICFILES_DIRS = []

STATICFILES_FINDERS = ['django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder']

STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'

STATIC_ROOT = None

STATIC_URL = '/static/'

TEMPLATES = [{'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': {'context_processors': ['django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages']}}]

TEST_NON_SERIALIZED_APPS = []

TEST_RUNNER = 'django.test.runner.DiscoverRunner'

THOUSAND_SEPARATOR = ','

TIME_FORMAT = 'P'

TIME_INPUT_FORMATS = ['%H:%M:%S', '%H:%M:%S.%f', '%H:%M']

TIME_ZONE = 'UTC'

USE_ETAGS = False

USE_I18N = True

USE_L10N = True

USE_THOUSAND_SEPARATOR = False

USE_TZ = True

USE_X_FORWARDED_HOST = False

USE_X_FORWARDED_PORT = False

WSGI_APPLICATION = 'marsha.wsgi.application'

X_FRAME_OPTIONS = 'SAMEORIGIN'

YEAR_MONTH_FORMAT = 'F Y'

class marsha.settings.Dev

Bases: marsha.settings.Base

Development environment settings.

We set DEBUG to True by default, configure the server to respond to all hosts, and use a local sqlite database by default.

ABSOLUTE_URL_OVERRIDES = {}

ADMINS = []

ALLOWED_HOSTS = ['*']

APPEND_SLASH = True

AUTHENTICATION_BACKENDS = ['django.contrib.auth.backends.ModelBackend']

AUTH_PASSWORD_VALIDATORS = [{'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator'}, {'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator'}, {'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator'}, {'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator'}]

AUTH_USER_MODEL = 'core.User'

BASE_DIR = '/home/docs/checkouts/readthedocs.org/user_builds/marsha/envs/latest/lib/python3.6/site-packages/marsha'

CACHES = {'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}}

CACHE_MIDDLEWARE_ALIAS = 'default'

CACHE_MIDDLEWARE_KEY_PREFIX = ''

CACHE_MIDDLEWARE_SECONDS = 600

CSRF_COOKIE_AGE = 31449600

CSRF_COOKIE_DOMAIN = None

CSRF_COOKIE_HTTPONLY = False

CSRF_COOKIE_NAME = 'csrftoken'

CSRF_COOKIE_PATH = '/'

CSRF_COOKIE_SECURE = False

CSRF_FAILURE_VIEW = 'django.views.csrf.csrf_failure'

CSRF_HEADER_NAME = 'HTTP_X_CSRFTOKEN'

CSRF_TRUSTED_ORIGINS = []

CSRF_USE_SESSIONS = False

DATABASES = {'default': {'NAME': '/home/docs/checkouts/readthedocs.org/user_builds/marsha/envs/latest/lib/python3.6/site-packages/marsha/db.sqlite3', 'USER': '', 'PASSWORD': '', 'HOST': '', 'PORT': '', 'CONN_MAX_AGE': 0, 'ENGINE': 'django.db.backends.sqlite3', 'ATOMIC_REQUESTS': False, 'AUTOCOMMIT': True, 'OPTIONS': {}, 'TIME_ZONE': None, 'TEST': {'CHARSET': None, 'COLLATION': None, 'NAME': None, 'MIRROR': None}}}

DATABASE_ROUTERS = []

DATA_UPLOAD_MAX_MEMORY_SIZE = 2621440

DATA_UPLOAD_MAX_NUMBER_FIELDS = 1000

DATETIME_FORMAT = 'N j, Y, P'

DATETIME_INPUT_FORMATS = ['%Y-%m-%d %H:%M:%S', '%Y-%m-%d %H:%M:%S.%f', '%Y-%m-%d %H:%M', '%Y-%m-%d', '%m/%d/%Y %H:%M:%S', '%m/%d/%Y %H:%M:%S.%f', '%m/%d/%Y %H:%M', '%m/%d/%Y', '%m/%d/%y %H:%M:%S', '%m/%d/%y %H:%M:%S.%f', '%m/%d/%y %H:%M', '%m/%d/%y']

DATE_FORMAT = 'N j, Y'

DATE_INPUT_FORMATS = ['%Y-%m-%d', '%m/%d/%Y', '%m/%d/%y', '%b %d %Y', '%b %d, %Y', '%d %b %Y', '%d %b, %Y', '%B %d %Y', '%B %d, %Y', '%d %B %Y', '%d %B, %Y']

DEBUG = False

DEBUG_PROPAGATE_EXCEPTIONS = False

DECIMAL_SEPARATOR = '.'

DEFAULT_CHARSET = 'utf-8'

DEFAULT_CONTENT_TYPE = 'text/html'

DEFAULT_EXCEPTION_REPORTER_FILTER = 'django.views.debug.SafeExceptionReporterFilter'

DEFAULT_FILE_STORAGE = 'django.core.files.storage.FileSystemStorage'

DEFAULT_FROM_EMAIL = 'webmaster@localhost'

DEFAULT_INDEX_TABLESPACE = ''

DEFAULT_TABLESPACE = ''

DISALLOWED_USER_AGENTS = []

DOTENV_LOADED = None

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

EMAIL_HOST = 'localhost'

EMAIL_HOST_PASSWORD = ''

EMAIL_HOST_USER = ''

EMAIL_PORT = 25

EMAIL_SSL_CERTFILE = None

EMAIL_SSL_KEYFILE = None

EMAIL_SUBJECT_PREFIX = '[Django] '

EMAIL_TIMEOUT = None

EMAIL_USE_LOCALTIME = False

EMAIL_USE_SSL = False

EMAIL_USE_TLS = False

FILE_CHARSET = 'utf-8'

FILE_UPLOAD_DIRECTORY_PERMISSIONS = None

FILE_UPLOAD_HANDLERS = ['django.core.files.uploadhandler.MemoryFileUploadHandler', 'django.core.files.uploadhandler.TemporaryFileUploadHandler']

FILE_UPLOAD_MAX_MEMORY_SIZE = 2621440

FILE_UPLOAD_PERMISSIONS = None

FILE_UPLOAD_TEMP_DIR = None

FIRST_DAY_OF_WEEK = 0

FIXTURE_DIRS = []

FORCE_SCRIPT_NAME = None

FORMAT_MODULE_PATH = None

FORM_RENDERER = 'django.forms.renderers.DjangoTemplates'

IGNORABLE_404_URLS = []

INSTALLED_APPS = ['django.contrib.admin.apps.SimpleAdminConfig', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'django_extensions', 'marsha.core.apps.CoreConfig']

INTERNAL_IPS = []

LANGUAGES = [('en', 'english'), ('fr', 'french')]

LANGUAGES_BIDI = ['he', 'ar', 'fa', 'ur']

LANGUAGE_CODE = 'en-us'

LANGUAGE_COOKIE_AGE = None

LANGUAGE_COOKIE_DOMAIN = None

LANGUAGE_COOKIE_NAME = 'django_language'

LANGUAGE_COOKIE_PATH = '/'

LOCALE_PATHS = []

LOGGING = {}

LOGGING_CONFIG = 'logging.config.dictConfig'

LOGIN_REDIRECT_URL = '/accounts/profile/'

LOGIN_URL = '/accounts/login/'

LOGOUT_REDIRECT_URL = None

MANAGERS = []

MEDIA_ROOT = ''

MEDIA_URL = ''

MESSAGE_STORAGE = 'django.contrib.messages.storage.fallback.FallbackStorage'

MIDDLEWARE = ['django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware']

MIGRATION_MODULES = {}

MONTH_DAY_FORMAT = 'F j'

NUMBER_GROUPING = 0

PASSWORD_HASHERS = ['django.contrib.auth.hashers.PBKDF2PasswordHasher', 'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher', 'django.contrib.auth.hashers.Argon2PasswordHasher', 'django.contrib.auth.hashers.BCryptSHA256PasswordHasher', 'django.contrib.auth.hashers.BCryptPasswordHasher']

PASSWORD_RESET_TIMEOUT_DAYS = 3

PREPEND_WWW = False

ROOT_URLCONF = 'marsha.urls'

SECRET_KEY = 'FooBar'

SECURE_BROWSER_XSS_FILTER = False

SECURE_CONTENT_TYPE_NOSNIFF = False

SECURE_HSTS_INCLUDE_SUBDOMAINS = False

SECURE_HSTS_PRELOAD = False

SECURE_HSTS_SECONDS = 0

SECURE_PROXY_SSL_HEADER = None

SECURE_REDIRECT_EXEMPT = []

SECURE_SSL_HOST = None

SECURE_SSL_REDIRECT = False

SERVER_EMAIL = 'root@localhost'

SESSION_CACHE_ALIAS = 'default'

SESSION_COOKIE_AGE = 1209600

SESSION_COOKIE_DOMAIN = None

SESSION_COOKIE_HTTPONLY = True

SESSION_COOKIE_NAME = 'sessionid'

SESSION_COOKIE_PATH = '/'

SESSION_COOKIE_SECURE = False

SESSION_ENGINE = 'django.contrib.sessions.backends.db'

SESSION_EXPIRE_AT_BROWSER_CLOSE = False

SESSION_FILE_PATH = None

SESSION_SAVE_EVERY_REQUEST = False

SESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'

SHORT_DATETIME_FORMAT = 'm/d/Y P'

SHORT_DATE_FORMAT = 'm/d/Y'

SIGNING_BACKEND = 'django.core.signing.TimestampSigner'

SILENCED_SYSTEM_CHECKS = []

STATICFILES_DIRS = []

STATICFILES_FINDERS = ['django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder']

STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'

STATIC_ROOT = None

STATIC_URL = '/static/'

TEMPLATES = [{'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': {'context_processors': ['django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages']}}]

TEST_NON_SERIALIZED_APPS = []

TEST_RUNNER = 'django.test.runner.DiscoverRunner'

THOUSAND_SEPARATOR = ','

TIME_FORMAT = 'P'

TIME_INPUT_FORMATS = ['%H:%M:%S', '%H:%M:%S.%f', '%H:%M']

TIME_ZONE = 'UTC'

USE_ETAGS = False

USE_I18N = True

USE_L10N = True

USE_THOUSAND_SEPARATOR = False

USE_TZ = True

USE_X_FORWARDED_HOST = False

USE_X_FORWARDED_PORT = False

WSGI_APPLICATION = 'marsha.wsgi.application'

X_FRAME_OPTIONS = 'SAMEORIGIN'

YEAR_MONTH_FORMAT = 'F Y'

marsha.stubs module

Stubs for the whole project to be used for typing annotations.

class marsha.stubs.M2MType

Bases: typing.Generic

Stub to represent both sides of a django ManyToManyField.

add(*objs) → None

clear() → None

create(**kwargs) → T

get_or_create(**kwargs) → Tuple[T, bool]

remove(*objs) → None

set(objs: Iterable[T], clear: Union[bool, NoneType] = False) → None

update_or_create(**kwargs) → Tuple[T, bool]

class marsha.stubs.ReverseFKType

Bases: typing.Generic

Stub to represent the related field of a django ForeignKey/OneToOneField.

add(*objs, bulk: Union[bool, NoneType] = True) → None

clear(bulk: bool = True) → None

create(**kwargs) → T

get_or_create(**kwargs) → Tuple[T, bool]

remove(*objs, bulk: Union[bool, NoneType] = True) → None

set(objs: Iterable[T], bulk: Union[bool, NoneType] = True, clear: Union[bool, NoneType] = False) → None

update_or_create(**kwargs) → Tuple[T, bool]

marsha.stubs.ReverseO2O

alias of marsha.stubs.ReverseFKType

marsha.test_runner module

Provides a test-runner to avoid running django checks.

class marsha.test_runner.NoCheckDiscoverRunner(pattern=None, top_level=None, verbosity=1, interactive=True, failfast=False, keepdb=False, reverse=False, debug_mode=False, debug_sql=False, parallel=0, tags=None, exclude_tags=None, **kwargs)

Bases: django.test.runner.DiscoverRunner

A Django test runner that do not run checks.

run_checks() → None

Do not run checks.

marsha.urls module

Marsha URLs configuration.

marsha.wsgi module

WSGI script for the marsha project.

Module contents

Marsha project.