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

  • setup_helper
    • Functions
      • run_first_time_setup

Other Formats

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

setup_helper

utils.setup_helper

Helper module for first-time setup.

Functions

Name Description
run_first_time_setup Run first-time setup for the package.

run_first_time_setup

utils.setup_helper.run_first_time_setup(console=None)

Run first-time setup for the package.

This guides the user through setting up their database credentials and other configuration options.

Parameters

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