Treasury Analytics Core
  • Home
  • API Reference
  • Examples
  • Credentials
  • Global Settings
  1. API Reference
  2. Configuration
  3. settings
  • Overview
    • Treasury Analytics Core
  • Credential Management
    • Secure Credential Management
    • Global Settings
  • Examples
    • Example Projects
  • API Reference
    • Function reference
    • Core Components
      • FinanceDataEngine
      • engine_factory
      • engine
      • database
      • cache
      • processor
      • analyzer
    • Configuration
      • settings
      • settings_factory
      • global_settings_manager
    • Utilities
      • credentials
      • dataframe_utils
      • setup_logging
      • env_checker
      • query_timer
      • setup_helper
      • logging
      • constants
      • types
    • Scripts
      • configure_db
      • create_project
      • manage_settings

On this page

  • settings
    • Classes
      • DatabaseSettings
      • LoggingSettings
      • PathSettings
      • ProcessingSettings
      • Settings

Other Formats

  • Github (GFM)
  1. API Reference
  2. Configuration
  3. settings

settings

config.settings

Settings configuration using Pydantic.

Classes

Name Description
DatabaseSettings Database connection settings.
LoggingSettings Logging settings.
PathSettings Path settings for project files.
ProcessingSettings Data processing settings.
Settings Combined settings for the application.

DatabaseSettings

config.settings.DatabaseSettings()

Database connection settings.

LoggingSettings

config.settings.LoggingSettings()

Logging settings.

PathSettings

config.settings.PathSettings(self, **kwargs)

Path settings for project files.

ProcessingSettings

config.settings.ProcessingSettings(self, **kwargs)

Data processing settings.

Settings

config.settings.Settings(self, **kwargs)

Combined settings for the application.

Methods

Name Description
from_credential_path Load settings with database credentials from a specified path.
from_keyring Load settings with database credentials from system keyring.
from_credential_path
config.settings.Settings.from_credential_path(cred_path, **kwargs)

Load settings with database credentials from a specified path.

Parameters
Name Type Description Default
cred_path str Path to directory containing database credentials file (.env format) required
Returns
Name Type Description
Settings Settings object with loaded credentials
from_keyring
config.settings.Settings.from_keyring(
    service_name='nova_fde',
    username=None,
    **kwargs,
)

Load settings with database credentials from system keyring.

Parameters
Name Type Description Default
service_name str Service name for keyring 'nova_fde'
username Optional[str] Username to look up in keyring None
Returns
Name Type Description
Settings Settings object with credentials from keyring
analyzer
settings_factory
 
 
  • Built with [Quarto](https://quarto.org/) and [quartodoc](https://machow.github.io/quartodoc/)