Skip to content

Getting Started

Prerequisites

  • Python 3.13+
  • uv package manager

Installation

Install the core package (minimal runtime deps: numpy, pandas, pydantic, rich, requests):

Bash
uv add mayutils

Install specific optional groups for the functionality you need:

Bash
# plotting helpers (plotly, kaleido, matplotlib, scipy, etc.)
uv add "mayutils[plotting]"

# Snowflake + SQLAlchemy integrations
uv add "mayutils[snowflake]"

# Curated default for notebook-based data analysis
# (console + pandas + datetime + notebook + plotting + secrets)
uv add "mayutils[recommended]"

# Everything
uv add "mayutils[all]"

See Dependency Groups for the full mapping of groups to submodules.

For Development

Bash
git clone git@github.com:mayurankv/mayutils.git
cd mayutils
make init
source .venv/bin/activate

make init creates a virtual environment, installs the dev + docs + testing groups, and installs prek git hooks (pre-commit, commit-msg, and pre-push).

Quick Usage

Python
import mayutils
from mayutils.objects.numbers import format_number

mayutils.setup()  # configure logging + notebook/dataframe niceties (safe no-op without extras)

print(format_number(value=1_234_567))

For plotting (requires the plotting extra):

Python
from mayutils.visualisation.graphs.plotly import charts

charts.histogram(...)

Next Steps