# Tracktolib
[![Python versions](https://img.shields.io/pypi/pyversions/tracktolib)](https://pypi.python.org/pypi/tracktolib)
[![Latest PyPI version](https://img.shields.io/pypi/v/tracktolib?logo=pypi)](https://pypi.python.org/pypi/tracktolib)
[![CircleCI](https://circleci.com/gh/Tracktor/tracktolib/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/Tracktor/tracktolib?branch=master)
Utility library for python
# Installation
You can choose to not install all the dependencies by specifying
the [extra](https://python-poetry.org/docs/cli/#options-4) parameter such as:
```bash
poetry add tracktolib@latest -E pg-sync -E tests --group dev
```
Here we only install the utilities using `psycopg` (pg-sync) and `deepdiff` (tests) for the dev environment.
# Utilities
- **log**
Utility functions for logging.
```python
import logging
from tracktolib.logs import init_logging
logger = logging.getLogger()
formatter, stream_handler = init_logging(logger, 'json', version='0.0.1')
```
- **pg**
Utility functions for [asyncpg](https://github.com/MagicStack/asyncpg)
- **pg-sync**
Utility functions based on psycopg such as `fetch_one`, `insert_many`, `fetch_count` ...
To use the functions, create a `Connection` using psycopg: `conn = psycopg2.connect()`
*fetch_one*
```python
from tracktolib.pg.pg_sync import (
insert_many, fetch_one, fetch_count, fetch_all
)
data = [
{'foo': 'bar', 'value': 1},
{'foo': 'baz', 'value': 2}
]
insert_many(conn, 'public.test', data) # Will insert the 2 dict
query = 'SELECT foo from public.test order by value asc'
value = fetch_one(conn, query, required=True) # Will return {'foo': 'bar'}, raise an error is not found
assert fetch_count(conn, 'public.test') == 2
query = 'SELECT * from public.test order by value asc'
assert fetch_all(conn, query) == data
```
- **tests**
Utility functions for testing
- **s3-minio**
Utility functions for [minio](https://min.io/docs/minio/linux/developers/python/API.html)
- **s3**
Utility functions for [aiobotocore](https://github.com/aio-libs/aiobotocore)
- **logs**
Utility functions to initialize the logging formatting and streams
- **http**
Utility functions using [httpx](https://www.python-httpx.org/)
- **api**
Utility functions using [fastapi](https://fastapi.tiangolo.com/)
Raw data
{
"_id": null,
"home_page": "https://github.com/tracktor/tracktolib",
"name": "tracktolib",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "utility",
"author": "Julien Brayere",
"author_email": "julien.brayere@tracktor.fr",
"download_url": "https://files.pythonhosted.org/packages/49/b3/5d4fc3dc6120a99f4974f54b60198d44333d233bd2a531164c718ca7e85e/tracktolib-0.53.1.tar.gz",
"platform": null,
"description": "# Tracktolib\n\n[![Python versions](https://img.shields.io/pypi/pyversions/tracktolib)](https://pypi.python.org/pypi/tracktolib)\n[![Latest PyPI version](https://img.shields.io/pypi/v/tracktolib?logo=pypi)](https://pypi.python.org/pypi/tracktolib)\n[![CircleCI](https://circleci.com/gh/Tracktor/tracktolib/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/Tracktor/tracktolib?branch=master)\n\nUtility library for python\n\n# Installation\n\nYou can choose to not install all the dependencies by specifying\nthe [extra](https://python-poetry.org/docs/cli/#options-4) parameter such as:\n\n```bash\npoetry add tracktolib@latest -E pg-sync -E tests --group dev \n```\n\nHere we only install the utilities using `psycopg` (pg-sync) and `deepdiff` (tests) for the dev environment.\n\n# Utilities\n\n- **log**\n\nUtility functions for logging.\n\n```python\nimport logging\nfrom tracktolib.logs import init_logging\n\nlogger = logging.getLogger()\nformatter, stream_handler = init_logging(logger, 'json', version='0.0.1')\n```\n\n- **pg**\n\nUtility functions for [asyncpg](https://github.com/MagicStack/asyncpg)\n\n- **pg-sync**\n\nUtility functions based on psycopg such as `fetch_one`, `insert_many`, `fetch_count` ...\n\nTo use the functions, create a `Connection` using psycopg: `conn = psycopg2.connect()`\n\n*fetch_one*\n\n```python\nfrom tracktolib.pg.pg_sync import (\n insert_many, fetch_one, fetch_count, fetch_all\n)\n\ndata = [\n {'foo': 'bar', 'value': 1},\n {'foo': 'baz', 'value': 2}\n]\ninsert_many(conn, 'public.test', data) # Will insert the 2 dict\nquery = 'SELECT foo from public.test order by value asc'\nvalue = fetch_one(conn, query, required=True) # Will return {'foo': 'bar'}, raise an error is not found\nassert fetch_count(conn, 'public.test') == 2\nquery = 'SELECT * from public.test order by value asc'\nassert fetch_all(conn, query) == data\n\n```\n\n- **tests**\n\nUtility functions for testing\n\n- **s3-minio**\n\nUtility functions for [minio](https://min.io/docs/minio/linux/developers/python/API.html)\n\n- **s3**\n\nUtility functions for [aiobotocore](https://github.com/aio-libs/aiobotocore)\n\n- **logs**\n\nUtility functions to initialize the logging formatting and streams\n\n- **http**\n\nUtility functions using [httpx](https://www.python-httpx.org/)\n\n- **api**\n\nUtility functions using [fastapi](https://fastapi.tiangolo.com/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Utility library for python",
"version": "0.53.1",
"project_urls": {
"Homepage": "https://github.com/tracktor/tracktolib",
"Repository": "https://github.com/tracktor/tracktolib"
},
"split_keywords": [
"utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0247e6f90e009440910764a3df1cf65b1d3ff00ce6714228f27fc45cb272cc08",
"md5": "b75d16f714baa0d645cbf0a9e210c4ca",
"sha256": "762ceb28e3d191545854f7576042b4d21e102e651ca110805feb50c4de4a870c"
},
"downloads": -1,
"filename": "tracktolib-0.53.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b75d16f714baa0d645cbf0a9e210c4ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 22920,
"upload_time": "2025-01-22T19:11:17",
"upload_time_iso_8601": "2025-01-22T19:11:17.122754Z",
"url": "https://files.pythonhosted.org/packages/02/47/e6f90e009440910764a3df1cf65b1d3ff00ce6714228f27fc45cb272cc08/tracktolib-0.53.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49b35d4fc3dc6120a99f4974f54b60198d44333d233bd2a531164c718ca7e85e",
"md5": "63159eeddd145bf09f52bcd9c55ea20d",
"sha256": "7be1e8fd7daa0f948bcfb2420e9ac83bfc1b45567913fffbd476863746cba036"
},
"downloads": -1,
"filename": "tracktolib-0.53.1.tar.gz",
"has_sig": false,
"md5_digest": "63159eeddd145bf09f52bcd9c55ea20d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 19337,
"upload_time": "2025-01-22T19:11:18",
"upload_time_iso_8601": "2025-01-22T19:11:18.264501Z",
"url": "https://files.pythonhosted.org/packages/49/b3/5d4fc3dc6120a99f4974f54b60198d44333d233bd2a531164c718ca7e85e/tracktolib-0.53.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-22 19:11:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tracktor",
"github_project": "tracktolib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "tracktolib"
}