# muttlib πΆπ
[![pypi version](https://img.shields.io/pypi/v/muttlib?color=blue)](https://pypi.org/project/muttlib/)
[![pipeline status](https://gitlab.com/mutt_data/muttlib/badges/master/pipeline.svg)](https://gitlab.com/mutt_data/muttlib/-/commits/master)
[![coverage report](https://gitlab.com/mutt_data/muttlib/badges/master/coverage.svg)](https://gitlab.com/mutt_data/muttlib/-/commits/master)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
<!-- TODO: fix for github -->
<!-- [![docstring report](https://gitlab.com/mutt_data/muttlib/-/jobs/artifacts/master/raw/docs_coverage.svg?job=docstr-cov)](https://interrogate.readthedocs.io/en/latest/) -->
## Description
Library with helper code to start a data-related project.
By [Mutt Data](https://muttdata.ai/).
Current modules:
- `dbconn`: Somewhat homogeneus lib to access multiple DBs.
- `file_processing`: Helpers for concurrent file processing.
- `forecast`: Provides FBProphet a common interface to Sklearn and general
utilities for forecasting problems, allowing wider and easier grid search for
hyperparameters.
- `utils`: A single version of miscellaneous functions needed every now and then.
- `gsheetsconn`: Module to make data interactions to/from Google Sheets <> Pandas.
- `gdrive`: Module that provides a UNIX-ish interface to GDrive.
## Table of Contents
- [muttlib πΆπ](#muttlib-)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Installing from PyPi](#installing-from-pypi)
- [Installing custom branches from the repos](#installing-custom-branches-from-the-repos)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
### Installing from PyPI
_Note:_ `muttlib` is packaged and developed using [poetry](https://python-poetry.org).
Base lib:
```bash
poetry add muttlib
```
Check below for available extras.
Parquet and Feather support:
```bash
poetry add muttlib -E pyarrow
```
Forecast:
```bash
poetry add muttlib -E forecast
```
Misc DB support for dbconn:
```bash
poetry add muttlib -E oracle
poetry add muttlib -E hive
poetry add muttlib -E postgres
poetry add muttlib -E mysql
poetry add muttlib -E sqlserver
poetry add muttlib -E mongo
poetry add muttlib -E ibis
```
_Note:_ the `ibis` extra requires installing binary packages. Check [CONTRIBUTING.md](https://github.com/MuttData/muttlib/blob/master/CONTRIBUTING.md#prerequisites) for the full list.
### Installing custom branches from the repos
From GitHub mirror:
```bash
poetry add -e git+https://github.com/MuttData/muttlib.git@AWESOME_FEATURE_BRANCH#egg=muttlib
```
From Gitlab main repo:
```bash
poetry add -e git+https://gitlab.com/mutt_data/muttlib.git@AWESOME_FEATURE_BRANCH#egg=muttlib
```
## Usage
See the [documentation](https://mutt_data.gitlab.io/muttlib/) to get started with `muttlib`.
## Contributing
We appreciate for considering to help out maintaining this project. If you'd like to contribute please read our [contributing guidelines](https://mutt_data.gitlab.io/muttlib/contributing.html).
## License
`muttlib` is licensed under the [Apache License 2.0](https://github.com/MuttData/muttlib/blob/master/LICENCE).
Raw data
{
"_id": null,
"home_page": "https://github.com/MuttData/muttlib",
"name": "muttlib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "data,muttdata",
"author": "Mutt Data",
"author_email": "info@muttdata.ai",
"download_url": "https://files.pythonhosted.org/packages/fc/28/7fe37ba7b77501fe33fba7222e84225ade02dd89c8114ddb5ac186bb061b/muttlib-1.4.27.tar.gz",
"platform": null,
"description": "# muttlib \ud83d\udc36\ud83d\udcda\n\n[![pypi version](https://img.shields.io/pypi/v/muttlib?color=blue)](https://pypi.org/project/muttlib/)\n[![pipeline status](https://gitlab.com/mutt_data/muttlib/badges/master/pipeline.svg)](https://gitlab.com/mutt_data/muttlib/-/commits/master)\n[![coverage report](https://gitlab.com/mutt_data/muttlib/badges/master/coverage.svg)](https://gitlab.com/mutt_data/muttlib/-/commits/master)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n<!-- TODO: fix for github -->\n<!-- [![docstring report](https://gitlab.com/mutt_data/muttlib/-/jobs/artifacts/master/raw/docs_coverage.svg?job=docstr-cov)](https://interrogate.readthedocs.io/en/latest/) -->\n\n## Description\n\nLibrary with helper code to start a data-related project.\nBy [Mutt Data](https://muttdata.ai/).\n\nCurrent modules:\n\n- `dbconn`: Somewhat homogeneus lib to access multiple DBs.\n- `file_processing`: Helpers for concurrent file processing.\n- `forecast`: Provides FBProphet a common interface to Sklearn and general\n utilities for forecasting problems, allowing wider and easier grid search for\n hyperparameters.\n- `utils`: A single version of miscellaneous functions needed every now and then.\n- `gsheetsconn`: Module to make data interactions to/from Google Sheets <> Pandas.\n- `gdrive`: Module that provides a UNIX-ish interface to GDrive.\n\n## Table of Contents\n\n- [muttlib \ud83d\udc36\ud83d\udcda](#muttlib-)\n - [Description](#description)\n - [Table of Contents](#table-of-contents)\n - [Installing from PyPi](#installing-from-pypi)\n - [Installing custom branches from the repos](#installing-custom-branches-from-the-repos)\n - [Usage](#usage)\n - [Contributing](#contributing)\n - [License](#license)\n\n### Installing from PyPI\n\n_Note:_ `muttlib` is packaged and developed using [poetry](https://python-poetry.org).\n\nBase lib:\n\n```bash\npoetry add muttlib\n```\n\nCheck below for available extras.\n\nParquet and Feather support:\n\n```bash\npoetry add muttlib -E pyarrow\n```\n\nForecast:\n\n```bash\npoetry add muttlib -E forecast\n```\n\nMisc DB support for dbconn:\n\n```bash\npoetry add muttlib -E oracle\npoetry add muttlib -E hive\npoetry add muttlib -E postgres\npoetry add muttlib -E mysql\npoetry add muttlib -E sqlserver\npoetry add muttlib -E mongo\npoetry add muttlib -E ibis\n```\n\n_Note:_ the `ibis` extra requires installing binary packages. Check [CONTRIBUTING.md](https://github.com/MuttData/muttlib/blob/master/CONTRIBUTING.md#prerequisites) for the full list.\n\n### Installing custom branches from the repos\n\nFrom GitHub mirror:\n\n```bash\npoetry add -e git+https://github.com/MuttData/muttlib.git@AWESOME_FEATURE_BRANCH#egg=muttlib\n```\n\nFrom Gitlab main repo:\n\n```bash\npoetry add -e git+https://gitlab.com/mutt_data/muttlib.git@AWESOME_FEATURE_BRANCH#egg=muttlib\n```\n\n## Usage\n\nSee the [documentation](https://mutt_data.gitlab.io/muttlib/) to get started with `muttlib`.\n\n## Contributing\n\nWe appreciate for considering to help out maintaining this project. If you'd like to contribute please read our [contributing guidelines](https://mutt_data.gitlab.io/muttlib/contributing.html).\n\n## License\n\n`muttlib` is licensed under the [Apache License 2.0](https://github.com/MuttData/muttlib/blob/master/LICENCE).\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Collection of helper modules by Mutt Data.",
"version": "1.4.27",
"project_urls": {
"Homepage": "https://github.com/MuttData/muttlib",
"Repository": "https://github.com/MuttData/muttlib"
},
"split_keywords": [
"data",
"muttdata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "22275f2e3fd630b0fc4b2a735d006286774e57d7a5ceb8bba2d332e5b3e4bddd",
"md5": "f212a4f272387db10b835c65b232a012",
"sha256": "fd0a6cd5b7f28ecd947a0551ff6d2a907d7692add5b8b1f7ae76fa91f531ff83"
},
"downloads": -1,
"filename": "muttlib-1.4.27-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f212a4f272387db10b835c65b232a012",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 57560,
"upload_time": "2023-10-20T17:46:39",
"upload_time_iso_8601": "2023-10-20T17:46:39.442411Z",
"url": "https://files.pythonhosted.org/packages/22/27/5f2e3fd630b0fc4b2a735d006286774e57d7a5ceb8bba2d332e5b3e4bddd/muttlib-1.4.27-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc287fe37ba7b77501fe33fba7222e84225ade02dd89c8114ddb5ac186bb061b",
"md5": "145b0850084dbeed2c6888812effb4ba",
"sha256": "770226cfba9a96124c56de5f254777229bbf395c47856d7fd59051a979dc8903"
},
"downloads": -1,
"filename": "muttlib-1.4.27.tar.gz",
"has_sig": false,
"md5_digest": "145b0850084dbeed2c6888812effb4ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 51090,
"upload_time": "2023-10-20T17:46:41",
"upload_time_iso_8601": "2023-10-20T17:46:41.132026Z",
"url": "https://files.pythonhosted.org/packages/fc/28/7fe37ba7b77501fe33fba7222e84225ade02dd89c8114ddb5ac186bb061b/muttlib-1.4.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-20 17:46:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MuttData",
"github_project": "muttlib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "muttlib"
}