Metadata-Version: 2.4
Name: umbitlib
Version: 0.1.0
Summary: A library containing functions and constants commonly used so they can be centrally hosted sourced and managed
License: MIT
License-File: LICENSE
Author: Ken Briercheck, Samuel Cloward, Kevin Galbraith, Luke Iremadze, Shuktika Maheshwari, Jed Nigro, Javier Prado, Martin Smith"
Requires-Python: >=3.14.0,<3.15.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: keyring (>=25.7.0,<26.0.0)
Requires-Dist: matplotlib (>=3.11.0,<4.0.0)
Requires-Dist: numpy (>=2.5.0,<3.0.0)
Requires-Dist: oracledb (>=4.0.0,<5.0.0)
Requires-Dist: pandas (>=3.0.0,<4.0.0)
Requires-Dist: pandera (>=0.33.0,<1.0.0)
Requires-Dist: psycopg2 (>=2.9.0,<3.0.0)
Requires-Dist: python-dateutil (>=2.9.0,<3.0.0)
Requires-Dist: scipy (>=1.18.0,<2.0.0)
Requires-Dist: seaborn (>=0.13.0,<1.0.0)
Requires-Dist: sqlalchemy (>=2.0.0,<3.0.0)
Description-Content-Type: text/markdown

# Umbitlib

This is a library containing commonly used functions and constants so that they can be centrally hosted, sourced, tested, and managed

Functions being added to the library should

- Include a clear description of the function's purpose
- Include parameter definitions for easy access in the tooltip
- Include descriptive comments and formatting to aid in reading the code
- Include specific unit tests for the function in the corresponding tests file
- Follow DRY (Don't Repeat Yourself) coding practices where possible
- Include input cleaning and/or explicit parameter-typing  to prevent end-users from entering incorrect values

For an example submission including tests see the 'add()' function in umbitlib/helpers.py and tests/test_helpers.py

## Database connections

By default, database passwords are retrieved only from the system keyring and
connection settings are loaded only from
`C:\Cloud\Box\Analytics_Team\Configs\db_config.json`. The library no longer
looks for credentials or database settings in environment variables, Excel
workbooks, or other files. Callers may still explicitly provide one-off
credentials, configuration, or SQLAlchemy engine options. See
[`src/umbitlib/database/README.md`](src/umbitlib/database/README.md) for the
supported interfaces and examples.

