First Steps
Reference
Extended Reference
ApiConfig
feedback_handler()
json_response()
matomo_tracking()
app_name
urlpatterns
CmsConfig
WPBCryptPasswordHasher
modify_mfa_authenticated()
permission_required()
region_permission_required()
ActiveLanguageLinklist
EventTranslationLinklist
ImprintTranslationLinklist
NonArchivedLinkList
OrganizationLinklist
POITranslationLinklist
PageTranslationLinklist
is_page_author()
is_page_editor()
can_edit_all_pages()
can_publish_all_pages()
is_in_responsible_organization()
can_delete_chat_message()
CoreConfig
EmailAuthenticationBackend
DEEPL_AUTH_KEY
DEEPL_ENABLED
FCM_CREDENTIALS
FCM_ENABLED
GOOGLE_APPLICATION_CREDENTIALS
GOOGLE_PROJECT_ID
GOOGLE_TRANSLATE_ENABLED
LINKCHECK_DISABLE_LISTENERS
LOGGING
LOG_LEVEL
MESSAGE_LOGGING_ENABLED
SECRET_KEY
SUMM_AI_API_KEY
SUMM_AI_ENABLED
TEXTLAB_API_ENABLED
TEXTLAB_API_KEY
constants_processor()
settings_processor()
version_processor()
DATABASES
ColorFormatter
RequestFormatter
ADMINS
ALLOWED_HOSTS
API_EVENTS_MAX_TIME_SPAN_DAYS
AUTHENTICATION_BACKENDS
AUTHOR_CHAT_HISTORY_DAYS
AUTH_PASSWORD_VALIDATORS
AUTH_USER_MODEL
AVAILABLE_BRANDINGS
AVAILABLE_LANGUAGES
BASE_DIR
BASE_URL
BLOG_URLS
BRANDING
BRANDING_TITLE
CACHEOPS
CACHEOPS_DEFAULTS
CACHEOPS_DEGRADE_ON_FAILURE
CACHES
COMPANY
COMPANY_URL
CORS_ALLOW_HEADERS
CORS_ORIGIN_ALLOW_ALL
CSRF_FAILURE_VIEW
CURRENT_TIME_ZONE
CUSTOM_LOCALE_PATH
DEBUG
DEBUG_TOOLBAR_PANELS
DEEPL_API_URL
DEFAULT_AUTO_FIELD
DEFAULT_BLOG_URL
DEFAULT_BOUNDING_BOX
DEFAULT_FROM_EMAIL
DEFAULT_LANGUAGES
DEFAULT_REQUEST_TIMEOUT
DEFAULT_RSS_FEED_URL
DEPS_LOG_LEVEL
EMAIL_BACKEND
EMAIL_HOST
EMAIL_HOST_PASSWORD
EMAIL_HOST_USER
EMAIL_PORT
EMAIL_USE_SSL
EMAIL_USE_TLS
EXTERNAL_CALENDAR_CATEGORY
FCM_CHANNELS
FCM_DATA_URL
FCM_HISTORY_DAYS
FCM_NOTIFICATION_RETAIN_TIME_IN_HOURS
FCM_SCHEDULE_INTERVAL_MINUTES
FCM_URL
FORMAT_MODULE_PATH
GOOGLE_PARENT_PARAM
GOOGLE_TRANSLATE_LOCATION
GOOGLE_TRANSLATE_VERSION
GVZ_API_ENABLED
GVZ_API_URL
HIX_REQUIRED_FOR_MT
HOSTNAME
IMPRINT_SLUG
INSTALLED_APPS
INTERNAL_IPS
INTERNAL_URLS
LANGUAGES
LANGUAGE_CODE
LEGACY_FILE_UPLOAD
LINKCHECK_COMMAND_RUNNING
LINKCHECK_EMAIL_ENABLED
LINKCHECK_IGNORED_URL_TYPES
LINKCHECK_MAX_URL_LENGTH
LINKCHECK_PHONE_ENABLED
LINKCHECK_SITE_DOMAINS
LOCALE_PATHS
LOGFILE
LOGIN_REDIRECT_URL
LOGIN_URL
LOGOUT_REDIRECT_URL
MATOMO_TRACKING
MATOMO_URL
MAX_EVENT_DURATION
MEDIA_MAX_UPLOAD_SIZE
MEDIA_OPTIMIZED_SIZE
MEDIA_ROOT
MEDIA_THUMBNAIL_CROP
MEDIA_THUMBNAIL_SIZE
MEDIA_URL
MESSAGE_STORAGE
MIDDLEWARE
MT_CREDITS_ADDON
MT_CREDITS_FREE
MT_SOFT_MARGIN
MT_SOFT_MARGIN_FRACTION
NOMINATIM_API_ENABLED
NOMINATIM_API_URL
NUM_REGIONS_QUICK_ACCESS
OUTDATED_THRESHOLD_DAYS
PDF_DEACTIVATED_LANGUAGES
PDF_ROOT
PDF_URL
PER_PAGE
REDIS_CACHE
RELEASE_NOTES_DIRS
RESERVED_REGION_PAGE_PATTERNS
RESERVED_REGION_SLUGS
ROOT_URLCONF
RSS_FEED_URLS
SERIALIZATION_MODULES
SERVER_EMAIL
SHORT_LINKS_URL
SITE_DOMAIN
SOCIAL_PREVIEW_IMAGE
STATICFILES_DIRS
STATICFILES_FINDERS
STATIC_ROOT
STATIC_URL
SUMM_AI_API_URL
SUMM_AI_EASY_GERMAN_LANGUAGE_SLUG
SUMM_AI_GERMAN_LANGUAGE_SLUG
SUMM_AI_HTML_FIELDS
SUMM_AI_HTML_TAGS
SUMM_AI_INHERITED_FIELDS
SUMM_AI_IS_INITIAL
SUMM_AI_MAX_CONCURRENT_REQUESTS
SUMM_AI_MAX_RETRIES
SUMM_AI_RATE_LIMIT_COOLDOWN
SUMM_AI_SEPARATOR
SUMM_AI_TEST_MODE
SUMM_AI_TEXT_FIELDS
SUMM_AI_TIMEOUT
SYS_LOG_LEVEL
TEMPLATES
TEST
TEXTLAB_API_BULK_COOL_DOWN_PERIOD
TEXTLAB_API_BULK_WAITING_TIME
TEXTLAB_API_CONTENT_TYPES
TEXTLAB_API_DEFAULT_BENCHMARK_ID
TEXTLAB_API_LANGUAGES
TEXTLAB_API_URL
TEXTLAB_API_USERNAME
TIME_ZONE
USER_CHAT_TICKET_GROUP
USER_CHAT_WINDOW_LIMIT
USER_CHAT_WINDOW_MINUTES
USE_I18N
USE_L10N
USE_TZ
WEBAPP_URL
WEBPACK_LOADER
WEBSITE_URL
WIKI_URL
WSGI_APPLICATION
XLIFF_DEFAULT_FIELDS
XLIFF_DOWNLOAD_DIR
XLIFF_EXPORT_VERSION
XLIFF_LEGACY_FIELDS
XLIFF_ROOT
XLIFF_UPLOAD_DIR
XLIFF_URL
MessageLoggerStorage
application()
DeepLApiClientConfig
DeepLApiClient
DeepLProvider
FirebaseApiConfig
FirebaseApiClient
FirebaseDataClient
FirebaseSecurityService
GoogleTranslateApiClientConfig
GoogleTranslateApiClient
GoogleTranslateProvider
GvzApiConfig
GvzApiWrapper
GvzRegion
MatomoApiConfig
MatomoApiClient
MatomoException
NominatimApiConfig
NominatimApiClient
BoundingBox
SitemapConfig
EventSitemap
OfferSitemap
POISitemap
PageSitemap
WebappSitemap
get_sitemaps()
SitemapIndexView
SitemapView
SummAiApiConfig
SummAiApiClient
SummAiProvider
HTMLField
HTMLSegment
PatientTaskQueue
SummAiException
SummAiInvalidJSONError
SummAiRateLimitingExceeded
SummAiRuntimeError
TextField
TranslationHelper
worker()
TextlabApiConfig
TextlabClient
TextlabResult
check_hix_score()
dict_path()
format_hix_feedback()
XLIFFConfig
Deserializer
Serializer
XMLGeneratorWithCDATA
get_translation_key()
get_xliff_import_diff()
get_xliff_import_errors_and_clean_translation()
page_to_xliff()
pages_to_xliff_file()
xliff_import_confirm()
xliffs_to_pages()
API_ENDPOINTS
API_FEEDBACK_VIEWS
test_api_chat_create_attachment_success()
test_api_chat_first_chat()
test_api_chat_force_new_chat()
test_api_chat_get_attachment_incorrect_chat_failure()
test_api_chat_get_attachment_missing_attachment_failure()
test_api_chat_get_attachment_success()
test_api_chat_get_messages_failure()
test_api_chat_get_messages_success()
test_api_chat_incorrect_auth_error()
test_api_chat_missing_auth_error()
test_api_chat_ratelimiting()
test_api_chat_send_message()
test_api_is_chat_enabled_for_user()
test_api_feedback_errors()
test_api_feedback_invalid_method()
test_api_feedback_success()
test_api_push_page_content()
test_api_result()
test_duplicate_regions()
test_duplicate_regions_no_translations()
test_create_new_language_node()
test_delete_language_node()
test_move_language_node()
test_update_language_node()
test_login_failure()
test_login_success()
test_create_directory()
test_delete_directory()
test_delete_file()
test_directory_path()
test_edit_directory()
test_edit_file()
test_get_directory_content()
test_get_file_usages()
test_get_search_result()
test_move_file()
test_replace_file()
test_upload_file()
test_page_filters()
TestFirebaseApiClient
TestFirebaseDataClient
setup_deepl_supported_languages()
setup_fake_deepl_api_server()
test_deepl_bulk_mt_api_error()
FakeClient
setup_fake_google_translate_api()
setup_google_translate_supported_languages()
test_google_translate_error()
mt_setup()
test_automatic_translation()
test_bulk_mt()
test_bulk_mt_exceeds_limit()
test_bulk_mt_no_source_language()
test_bulk_mt_up_to_date()
test_bulk_mt_up_to_date_and_ready_for_mt()
test_deepl_bulk_mt_no_target_language()
check_mt_provider()
test_both_providers_available()
test_change_to_not_supporting_provider()
test_change_to_supporting_provider()
test_no_available_provider()
test_only_deepl_available()
test_only_google_translate_available()
get_content_translations()
get_english_name()
get_word_count()
test_pdf_export()
test_pdf_export_invalid()
SITEMAPS
test_sitemap()
attempts
test_auto_translate_easy_german()
test_check_rate_limit_exceeded()
test_missing_translation()
test_patient_task_queue_hit_rate_limit()
test_patient_task_queue_max_retries()
test_patient_task_queue_normal_deque()
test_summ_ai_error_handling()
test_translate_text_field_ddos_defense()
test_translate_text_field_hit_rate_limit()
test_translate_text_field_internal_server_error()
test_translate_text_field_successful_translation()
test_translate_text_forbidden()
test_translate_text_with_empty_text_field()
test_unexpected_html()
test_validate_response_invalid()
test_validate_response_valid()
test_worker()
MockedRegion
MockedRequest
enable_summ_api()
get_changed_pages()
make_mock_summ_ai_server()
make_mock_summ_ai_server_rate_limited()
make_rogue_summ_ai_server()
get_and_assert_200()
get_open_kwargs()
upload_files()
validate_xliff_import_response()
XLIFF_IMPORTS
test_xliff_export()
test_xliff_import()
ALL_ROLES
ANONYMOUS
HIGH_PRIV_STAFF_ROLES
PRIV_STAFF_ROLES
REGION_ROLES
ROLES
ROOT
STAFF_ROLES
WRITE_ROLES
load_test_data()
load_test_data_transactional()
login_role_user()
login_role_user_async()
mock_firebase_credentials()
mock_server()
pytest_plugins
MockServer
MockServer.__init__()
MockServer.configure()
MockServer.port
assert_message_in_log()
assert_no_error_messages()
disable_hix_post_save_signal()
get_error_messages()
get_messages()
Basic Concepts
author
autodoc_typehints
copyright
django_settings
django_version
extensions
extlinks
github_pages_url
github_repository
github_url
github_username
html_baseurl
html_favicon
html_last_updated_fmt
html_logo
html_show_sourcelink
html_show_sphinx
html_theme
html_theme_options
intersphinx_mapping
intersphinx_timeout
linkcode_resolve()
modindex_common_prefix
nitpick_ignore
nitpicky
project
release
rst_epilog
setup()
templates_path
develop
main
deploy
debugpy
PageFormView
Deployment
findlinks
checklinks
debugsqlshell
duplicate_pages
find_large_files
find_missing_versions
hix_bulk
import_pois_from_csv
replace_links
send_push_notifications
fix_internal_links
summ_ai_bulk
reset_mt_budget
LogCommand
DebugCommand
Contributing
Indices
This package contains a dummy Django app to simulate the serving of static files during tests with DEBUG=False