leaguemanager.lib.settings¶
Module Contents¶
Classes¶
Functions¶
Set the user app directory. |
|
Get the settings for the host application. |
Data¶
API¶
- leaguemanager.lib.settings.MODULE_NAME¶
‘leaguemanager’
- leaguemanager.lib.settings.HOST_APP_DIR¶
‘module_to_os_path(…)’
- leaguemanager.lib.settings.set_to_cwd_if_none(value: str) pathlib.Path¶
Set the user app directory.
- class leaguemanager.lib.settings.HostApplication¶
- app_name: str¶
None
- app_dir: pathlib.Path¶
‘var(…)’
- root_dir: pathlib.Path¶
‘var(…)’
- db_services_dir: pathlib.Path¶
‘var(…)’
- template_loader_dir: pathlib.Path¶
‘var(…)’
- schedule_loader_dir: pathlib.Path¶
‘var(…)’
- synth_data_dir: pathlib.Path¶
‘var(…)’
- excel_template_dir: pathlib.Path¶
‘var(…)’
- class UserApplication¶
User application settings.
- app_name: str¶
‘var(…)’
- app_dir: pathlib.Path¶
‘var(…)’
- root_dir: pathlib.Path¶
‘var(…)’
- db_services_dir: pathlib.Path¶
‘var(…)’
- db_config_dir: pathlib.Path¶
‘var(…)’
- class SecurityConfig¶
Security configuration settings.
- _str_to_list() list[str]¶
- crypt_schemes: str | list[str]¶
‘var(…)’
- class DatabaseConfig¶
Database settings configuration.
- sync_url: str | None¶
‘var(…)’
- async_url: str | None¶
‘var(…)’
- commit_type: Literal[autocommit, autocommit_include_redirects]¶
‘var(…)’
- echo: bool¶
‘bool_var(…)’
- echo_pool: bool¶
‘bool_var(…)’
- pool_size: int¶
‘var(…)’
- pool_max_overflow: int¶
‘var(…)’
- pool_timeout: int¶
‘var(…)’
- pool_recycle: int¶
‘var(…)’
- pool_pre_ping: bool¶
‘bool_var(…)’
- sqlite_data_directory: pathlib.Path¶
‘var(…)’
- sqlite_db_name: str¶
‘var(…)’
- class AlembicConfig¶
Configuration for Alembic migrations.
- migration_path: pathlib.Path¶
‘var(…)’
- config_file_path: pathlib.Path¶
‘var(…)’
- template_path: pathlib.Path¶
‘var(…)’
- class RoleConfig¶
Role configuration settings.
- default_user: str¶
‘var(…)’
- athlete: str¶
‘var(…)’
- team_manager: str¶
‘var(…)’
- official: str¶
‘var(…)’
- organization_admin: str¶
‘var(…)’
- superuser: str¶
‘var(…)’
- class EmailConfig¶
Email configuration settings.
- enabled: bool¶
‘var(…)’
- smtp_host: str¶
‘var(…)’
- smtp_port: int¶
‘var(…)’
- smtp_user: str¶
‘var(…)’
- smtp_password: str¶
‘var(…)’
- from_email: str¶
‘var(…)’
- from_name: str¶
‘var(…)’
- use_tls: bool¶
‘var(…)’
- use_ssl: bool¶
‘var(…)’
- timeout: int¶
‘var(…)’
- class KeysConfig¶
Keys configuration settings.
- league_manager: str¶
‘var(…)’
- svcs_registry: str¶
‘var(…)’
- svcs_container: str¶
‘var(…)’
- db_sync_service: str¶
‘var(…)’
- db_async_service: str¶
‘var(…)’
- session_scope: str¶
‘var(…)’
- user_app: leaguemanager.lib.settings.HostApplication.UserApplication¶
‘group(…)’
- db: leaguemanager.lib.settings.HostApplication.DatabaseConfig¶
‘group(…)’
- alembic: leaguemanager.lib.settings.HostApplication.AlembicConfig¶
‘group(…)’
- sec: leaguemanager.lib.settings.HostApplication.SecurityConfig¶
‘group(…)’
- role: leaguemanager.lib.settings.HostApplication.RoleConfig¶
‘group(…)’
- email: leaguemanager.lib.settings.HostApplication.EmailConfig¶
‘group(…)’
- keys: leaguemanager.lib.settings.HostApplication.KeysConfig¶
‘group(…)’
- leaguemanager.lib.settings.get_settings() leaguemanager.lib.settings.HostApplication¶
Get the settings for the host application.