Skip to content

MuttData/muttlib

Repository files navigation

muttlib 🐶📚

pypi version pipeline status coverage report Code style: black Imports: isort

Description

Library with helper code to start a data-related project. By Mutt Data.

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

Installing from PyPI

Note: muttlib is packaged and developed using poetry.

Base lib:

poetry add muttlib

Check below for available extras.

Parquet and Feather support:

poetry add muttlib -E pyarrow

Forecast:

poetry add muttlib -E forecast

Misc DB support for dbconn:

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 for the full list.

Installing custom branches from the repos

From GitHub mirror:

poetry add -e git+https://github.com/MuttData/muttlib.git@AWESOME_FEATURE_BRANCH#egg=muttlib

From Gitlab main repo:

poetry add -e git+https://gitlab.com/mutt_data/muttlib.git@AWESOME_FEATURE_BRANCH#egg=muttlib

Usage

See the documentation 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.

License

muttlib is licensed under the Apache License 2.0.