Metadata-Version: 2.1
Name: lgbsttracker
Version: 0.0.4
Summary: 0.0.4
Home-page: https://github.com/py4mac/lgbsttracker
License: MIT
Keywords: utilities,utils
Author: Py4mac
Author-email: boisbu@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: alembic (>=1.3.3,<2.0.0)
Requires-Dist: asynctest (>=0.13.0,<0.14.0)
Requires-Dist: autoflake (>=1.3.1,<2.0.0)
Requires-Dist: click
Requires-Dist: coverage (>=5.5,<6.0)
Requires-Dist: entrypoints
Requires-Dist: fastapi (>=0.48.0,<0.49.0)
Requires-Dist: google-api
Requires-Dist: google-api-core
Requires-Dist: grpcio
Requires-Dist: grpcio-tools
Requires-Dist: lock (>=2018.3.25,<2019.0.0)
Requires-Dist: numpy
Requires-Dist: pandas (>=0.25.3,<0.26.0)
Requires-Dist: prometheus-client
Requires-Dist: protoc_gen_swagger
Requires-Dist: psycopg2
Requires-Dist: pydantic (>=1.4,<2.0)
Requires-Dist: pytest (>=6.2.3,<7.0.0)
Requires-Dist: pytest-asyncio (>=0.10.0,<0.11.0)
Requires-Dist: pytest-cov (>=2.11.1,<3.0.0)
Requires-Dist: python-dateutil
Requires-Dist: querystring_parser
Requires-Dist: requests
Requires-Dist: sqlalchemy
Requires-Dist: sqlalchemy-utils
Requires-Dist: testfixtures (>=6.17.1,<7.0.0)
Project-URL: Documentation, http://lgbsttracker.py4mac.com
Project-URL: Repository, https://github.com/py4mac/lgbsttracker
Description-Content-Type: text/markdown

<H1>lgbsttracker</H1>
<p align="center">
<img src="https://img.shields.io/github/last-commit/py4mac/lgbsttracker.svg">
<a href="https://github.com/py4mac/" target="_blank">
    <img src="https://github.com/py4mac/lgbsttracker/workflows/Test/badge.svg" alt="Test">
</a>
<a href="https://codecov.io/gh/py4mac/lgbsttracker" target="_blank">
    <img src="https://codecov.io/gh/py4mac/lgbsttracker/branch/master/graph/badge.svg" alt="Coverage">
</a>
<a href="https://pypi.org/project/lgbsttracker" target="_blank">
    <img src="https://badge.fury.io/py/lgbsttracker.svg" alt="Package version">
</a>
</p>

---

**Trello Plan**: <a href="https://trello.com/b/lGICXLqL/lgbsttracker" target="_blank">https://trello.com/b/lGICXLqL/lgbsttracker</a>

**Documentation**: <a href="https://py4mac.github.io/lgbsttracker" target="_blank">https://py4mac.github.io/lgbsttracker</a>

**Source Code**: <a href="https://github.com/py4mac/lgbsttracker" target="_blank">https://github.com/py4mac/lgbsttracker</a>

---

## Requirements

Python 3.6+

## Installation

```bash
pip install lgbsttracker==0.0.4
```

## Example

### Use it with async def

```Python
from lbgsttracker import create_experiment
from lbgsttracker.entities import ExperimentCreate
...
await create_experiment(ExperimentCreate(experiment_uuid="experiment1"))
experiment = await get_experiment_by_uuid("experiment1")
_logger.info(f"Freshly created experiment: {experiment}")
```

## Environment variables

| Variable Name                    | Description                   | Default value                                         |
| -------------------------------- | ----------------------------- | ----------------------------------------------------- |
| EXPERIMENT_STORAGE_URI           | DB Experiment Storage URI     | Mandatory: to be set by the user before using library |
| SQL_DB_THREAD_POOL_EXECUTOR_SIZE | Thread pool size              | 100                                                   |
| MIN_CONNECTION_POOL_SIZE         | Minimum pool size connection  | 10                                                    |
| MAX_CONNECTION_POOL_SIZE         | Maxiumum pool size connection | 20                                                    |
| CONNECTION_POOL_RECYCLE_TIME     | Pool connection recycle time  | 30                                                    |

## Credits

- https://github.com/mlflow/mlflow/
- https://github.com/undera/pylgbst
- https://github.com/tiangolo/fastapi
- https://github.com/aalhour/cookiecutter-aiohttp-sqlalchemy/

## License

This project is licensed under the terms of the MIT license.

