Treasury Analytics Core
  • Home
  • API Reference
  • Examples
  • Credentials
  • Global Settings
  1. API Reference
  2. Utilities
  3. env_checker
  • 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

  • env_checker
    • Functions
      • check_env_file
      • print_env_example

Other Formats

  • Github (GFM)
  1. API Reference
  2. Utilities
  3. env_checker

env_checker

utils.env_checker

Environment setup validation utilities.

Functions

Name Description
check_env_file Check if .env file exists and contains required variables.
print_env_example Print an example .env file.

check_env_file

utils.env_checker.check_env_file(console=None)

Check if .env file exists and contains required variables.

Parameters

Name Type Description Default
console Optional[Console] Rich console for output, by default None None

Returns

Name Type Description
bool True if configuration is valid, False otherwise

print_env_example

utils.env_checker.print_env_example(console)

Print an example .env file.

Parameters

Name Type Description Default
console Console Rich console for output required
setup_logging
query_timer
 
 
  • Built with [Quarto](https://quarto.org/) and [quartodoc](https://machow.github.io/quartodoc/)