iotemplatelib package¶
Submodules¶
iotemplatelib.glob_local module¶
Global constants and variables for IO-Aero systems.
This module defines a set of constants and variables that are globally used throughout the IO-Aero software projects. These include configuration parameters, error messages, and default settings that are essential for the operation and error handling within various components of the system.
- iotemplatelib.glob_local.ARG_TASK(str)¶
in function calls and command line arguments throughout the software.
- Type:
A constant key used to reference the ‘task’ argument
- iotemplatelib.glob_local.ARG_TASK_CHOICE(str)¶
is intended to hold the user’s choice of task once determined at runtime.
- Type:
Initially set to an empty string, this variable
- iotemplatelib.glob_local.ARG_TASK_VERSION(str)¶
argument for tasks, indicating the version of the task being used.
- Type:
A constant key used to reference the ‘version’
- iotemplatelib.glob_local.FATAL_00_908(str)¶
This message is formatted with the name of the OS when raised.
- Type:
Error message template for unsupported operating systems.
- iotemplatelib.glob_local.IO_TEMPLATE_LIB_VERSION(str)¶
template library, indicating the version of the global constants and variables.
- Type:
The current version number of the IO-Aero
- iotemplatelib.glob_local.LOCALE(str)¶
ensuring consistent language and regional format settings.
- Type:
Default locale setting for the system to ‘en_US.UTF-8’,
- iotemplatelib.glob_local.INFO_00_007 = "INFO.00.007 Section: '{section}' - Parameter: '{name}'='{value}'"¶
Information message indicating the value of a specific configuration parameter.
- Type:
str
iotemplatelib.io_settings module¶
Managing the application configuration parameters.
This module initializes and configures the settings for the IO-Aero application using the Dynaconf library. It allows for a flexible, environment-specific configuration that supports multiple file formats and environment variables.
- iotemplatelib.io_settings.settings(Dynaconf)¶
settings. It is set to read configuration from TOML files specific to the IO-Aero project and environment variables with a specific prefix.
- Type:
A configuration object that handles the application
- iotemplatelib.io_settings.Usage¶
- This module should be imported to access the `settings` object which provides
- the configuration parameters across the application. For example
from config_module import settings print(settings.SOME_CONFIGURATION_KEY)
Module contents¶
IO-TEMPLATE-LIB.