Metadata-Version: 2.3
Name: mayutils
Version: 2.0.0
Summary: Utilities for Python from Mayuran Visakan
Author: Mayuran Visakan
Author-email: Mayuran Visakan <mayuran.k.v@gmail.com>
License: MIT License
         
         Copyright (c) 2025 Mayuran Visakan
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pydantic-settings>=2.10.1
Requires-Dist: mayutils[async,cli,console,dataframes,datetime,filesystem,financials,google,mathematics,microsoft,notebook,numerics,pandas,pdf,plotting,secrets,snowflake,sql,statistics,streamlit,tui,web] ; extra == 'all'
Requires-Dist: asyncer>=0.0.8 ; extra == 'async'
Requires-Dist: cookiecutter>=2.6.0 ; extra == 'cli'
Requires-Dist: mayutils[console] ; extra == 'cli'
Requires-Dist: typer ; extra == 'cli'
Requires-Dist: rich>=14.1.0 ; extra == 'console'
Requires-Dist: mayutils[pandas] ; extra == 'dataframes'
Requires-Dist: modin[all]>=0.35.0 ; extra == 'dataframes'
Requires-Dist: polars>=1.32.3 ; extra == 'dataframes'
Requires-Dist: dask ; extra == 'dataframes'
Requires-Dist: mayutils[numerics] ; extra == 'datetime'
Requires-Dist: pendulum[test]>=3.1.0 ; extra == 'datetime'
Requires-Dist: gitpython>=3.1.45 ; extra == 'filesystem'
Requires-Dist: watchdog>=6.0.0 ; extra == 'filesystem'
Requires-Dist: mayutils[numerics] ; extra == 'financials'
Requires-Dist: numpy-financial>=1.0.0 ; extra == 'financials'
Requires-Dist: google-api-python-client>=2.179.0 ; extra == 'google'
Requires-Dist: google-auth>=2.40.3 ; extra == 'google'
Requires-Dist: google-auth-httplib2>=0.2.0 ; extra == 'google'
Requires-Dist: google-auth-oauthlib>=1.2.2 ; extra == 'google'
Requires-Dist: google-cloud-storage>=3.3.0 ; extra == 'google'
Requires-Dist: mayutils[numerics] ; extra == 'mathematics'
Requires-Dist: sympy ; extra == 'mathematics'
Requires-Dist: numba>=0.62.0rc1 ; extra == 'mathematics'
Requires-Dist: fastexcel>=0.14 ; extra == 'microsoft'
Requires-Dist: openpyxl>=3.1.5 ; extra == 'microsoft'
Requires-Dist: python-docx>=1.2.0 ; extra == 'microsoft'
Requires-Dist: python-pptx>=1.0.2 ; extra == 'microsoft'
Requires-Dist: ipykernel>=6.30.1 ; extra == 'notebook'
Requires-Dist: itables>=2.4.5 ; extra == 'notebook'
Requires-Dist: jupyter>=1.1.1 ; extra == 'notebook'
Requires-Dist: jupysql>=0.11.1 ; extra == 'notebook'
Requires-Dist: mayutils[console] ; extra == 'notebook'
Requires-Dist: nbconvert>=7.16.6 ; extra == 'notebook'
Requires-Dist: unicodeit>=0.7.5 ; extra == 'notebook'
Requires-Dist: quarto-cli>=1.9.37 ; extra == 'notebook'
Requires-Dist: numpy>=2.3.2 ; extra == 'numerics'
Requires-Dist: mayutils[numerics] ; extra == 'pandas'
Requires-Dist: pandas>=2.3.2 ; extra == 'pandas'
Requires-Dist: pyarrow>=21.0.0 ; extra == 'pandas'
Requires-Dist: pillow>=11.3.0 ; extra == 'pdf'
Requires-Dist: pymupdf>=1.26.4 ; extra == 'pdf'
Requires-Dist: mayutils[numerics] ; extra == 'plotting'
Requires-Dist: dataframe-image>=0.2.7 ; extra == 'plotting'
Requires-Dist: great-tables>=0.18.0 ; extra == 'plotting'
Requires-Dist: html2image>=2.0.7 ; extra == 'plotting'
Requires-Dist: kaleido>=1.0.0 ; extra == 'plotting'
Requires-Dist: markdown ; extra == 'plotting'
Requires-Dist: matplotlib>=3.10.5 ; extra == 'plotting'
Requires-Dist: mistune>=3.2.0 ; extra == 'plotting'
Requires-Dist: pillow>=11.3.0 ; extra == 'plotting'
Requires-Dist: plotly>=6.3.0 ; extra == 'plotting'
Requires-Dist: scipy>=1.16.1 ; extra == 'plotting'
Requires-Dist: mayutils[console,pandas,datetime,notebook,plotting,secrets] ; extra == 'recommended'
Requires-Dist: python-dotenv>=1.1.1 ; extra == 'secrets'
Requires-Dist: keyring>=25.6.0 ; extra == 'secrets'
Requires-Dist: mayutils[sql] ; extra == 'snowflake'
Requires-Dist: snowflake-connector-python[secure-local-storage]>=3.17.2 ; extra == 'snowflake'
Requires-Dist: snowflake-snowpark-python>=1.27 ; extra == 'snowflake'
Requires-Dist: snowflake-sqlalchemy>=1.7.6 ; extra == 'snowflake'
Requires-Dist: sqlalchemy>=2.0.43,<2.1 ; extra == 'sql'
Requires-Dist: mayutils[numerics] ; extra == 'statistics'
Requires-Dist: scikit-learn>=1.7.1 ; extra == 'statistics'
Requires-Dist: scipy>=1.16.1 ; extra == 'statistics'
Requires-Dist: statsmodels ; extra == 'statistics'
Requires-Dist: bcrypt>=4.3.0 ; extra == 'streamlit'
Requires-Dist: streamlit>=1.49.0 ; extra == 'streamlit'
Requires-Dist: mayutils[cli,pandas,plotting,snowflake] ; extra == 'tui'
Requires-Dist: pyyaml>=6.0.2 ; extra == 'tui'
Requires-Dist: textual>=8.2.7 ; extra == 'tui'
Requires-Dist: textual-image>=0.13.2 ; extra == 'tui'
Requires-Dist: google-api-python-client-stubs>=1.34.0 ; extra == 'types'
Requires-Dist: lxml-stubs>=0.5.1 ; extra == 'types'
Requires-Dist: pandas-stubs>=2.3.2.250827 ; extra == 'types'
Requires-Dist: plotly-stubs>=0.1.3 ; extra == 'types'
Requires-Dist: pyarrow-stubs>=20.0.0.20251215 ; extra == 'types'
Requires-Dist: scipy-stubs>=1.16.2.4 ; extra == 'types'
Requires-Dist: types-cachetools>=6.2.0.20251022 ; extra == 'types'
Requires-Dist: types-decorator>=5.2.0.20250324 ; extra == 'types'
Requires-Dist: types-markdown>=3.10.0.20251106 ; extra == 'types'
Requires-Dist: types-openpyxl>=3.1.5.20250919 ; extra == 'types'
Requires-Dist: types-pycurl>=7.45.7.20250926 ; extra == 'types'
Requires-Dist: types-python-dateutil>=2.9.0.20251008 ; extra == 'types'
Requires-Dist: types-pyyaml>=6.0.12.20250915 ; extra == 'types'
Requires-Dist: types-requests>=2.32.4.20250913 ; extra == 'types'
Requires-Dist: types-simplejson>=3.20.0.20250822 ; extra == 'types'
Requires-Dist: types-six>=1.17.0.20250515 ; extra == 'types'
Requires-Dist: types-toml>=0.10.8.20240310 ; extra == 'types'
Requires-Dist: chromedriver-autoinstaller>=0.6.4 ; extra == 'web'
Requires-Dist: playwright>=1.55.0 ; extra == 'web'
Requires-Dist: selenium>=4.35.0 ; extra == 'web'
Maintainer: Mayuran Visakan
Maintainer-email: Mayuran Visakan <mayuran.k.v@gmail.com>
Requires-Python: >=3.13, <4.0
Provides-Extra: all
Provides-Extra: async
Provides-Extra: cli
Provides-Extra: console
Provides-Extra: dataframes
Provides-Extra: datetime
Provides-Extra: filesystem
Provides-Extra: financials
Provides-Extra: google
Provides-Extra: mathematics
Provides-Extra: microsoft
Provides-Extra: notebook
Provides-Extra: numerics
Provides-Extra: pandas
Provides-Extra: pdf
Provides-Extra: plotting
Provides-Extra: recommended
Provides-Extra: secrets
Provides-Extra: snowflake
Provides-Extra: sql
Provides-Extra: statistics
Provides-Extra: streamlit
Provides-Extra: tui
Provides-Extra: types
Provides-Extra: web
Description-Content-Type: text/markdown

# mayutils

[![CI](https://github.com/mayuran-visakan/mayutils/actions/workflows/ci.yaml/badge.svg)](https://github.com/mayuran-visakan/mayutils/actions/workflows/ci.yaml) [![Documentation](https://img.shields.io/badge/Documentation-mkdocs%20material-indigo.svg)](https://mayuran-visakan.github.io/mayutils/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)

Utilities for Python — plotting helpers, dataframe adapters, Snowflake/SQL glue, PowerPoint/PDF export, notebook display tweaks, OAuth helpers, and a fistful of miscellaneous object helpers. Heavy dependencies are grouped behind extras so the core install stays small.

## Quick Start

```zsh
uv add mayutils                   # core only
uv add "mayutils[plotting]"       # + plotly/kaleido/matplotlib/scipy
uv add "mayutils[recommended]"    # curated data-analysis set (console+pandas+datetime+notebook+plotting+secrets)
uv add "mayutils[all]"            # everything
```

```python
import mayutils
from mayutils.objects.numbers import prettify

mayutils.setup()
print(prettify(num=1_234_567))  # "1.23M"
```

## Dependency Groups

| Group         | Use it for                                                                    |
| ------------- | ----------------------------------------------------------------------------- |
| `plotting`    | `plotly`, `kaleido`, `matplotlib`, `scipy`, `great-tables`                    |
| `notebook`    | `jupyter`, `ipykernel`, `nbconvert`, `itables`, `jupysql`, `quarto-cli`       |
| `pandas`      | `pandas`, `pyarrow`                                                           |
| `dataframes`  | `polars`, `modin`, `dask` (+ `pandas`)                                        |
| `mathematics` | `sympy`, `numba`                                                              |
| `statistics`  | `scikit-learn`, `scipy`, `statsmodels`                                        |
| `financials`  | `numpy-financial`                                                             |
| `google`      | Google Drive / Sheets / Cloud Storage + auth                                  |
| `microsoft`   | `python-pptx`, `openpyxl`                                                     |
| `sql`         | `sqlalchemy`                                                                  |
| `snowflake`   | `snowflake-connector-python`, `snowflake-sqlalchemy` (+ `sql`)                |
| `streamlit`   | `streamlit`                                                                   |
| `web`         | `selenium`, `playwright`, `chromedriver-autoinstaller`                        |
| `pdf`         | `pymupdf`, `pillow`                                                           |
| `datetime`    | `pendulum`                                                                    |
| `cli`         | `typer`, `cookiecutter`                                                       |
| `filesystem`  | `gitpython`, `watchdog`                                                       |
| `secrets`     | `python-dotenv`, `keyring`                                                    |
| `recommended` | meta: `console` + `pandas` + `datetime` + `notebook` + `plotting` + `secrets` |
| `all`         | Every runtime extra                                                           |

Full details: [docs/guides/dependency-groups.md](docs/guides/dependency-groups.md).

## Documentation

- [Getting Started](docs/getting-started.md)
- [Development](docs/guides/development.md)
- [Testing](docs/guides/testing.md)
- [Documentation](docs/guides/documentation.md)
- [Roadmap](docs/roadmap.md) — translated from the legacy `.todo` file
- [Changelog](docs/changelog.md)
- [API Reference](https://mayuran-visakan.github.io/mayutils/reference/) — auto-generated from docstrings

## Contributing

See the [contributing guide](docs/contributing.md) for setup, commit conventions (Conventional Commits), and release flow.

## License

MIT — see [LICENSE](LICENSE).
