Metadata-Version: 2.1
Name: diego-utils
Version: 0.0.5
Summary: A package with useful data science functions I have developed and useful guidance.
Home-page: https://diego-lda.github.io/diego-utils/
Author: Diego Lara
Author-email: diegolaradeandres@gmail.com
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cloudpathlib[gs]>=0.15.1
Requires-Dist: humanfriendly>=9.1
Requires-Dist: more-itertools>=9.0.0
Requires-Dist: pandas>=2.2.3
Requires-Dist: numpy>=2.1.0
Requires-Dist: pydantic>=2.6.2
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: scipy==1.15.0
Requires-Dist: tomli>=2.0.1
Requires-Dist: google-cloud-bigquery>=3.17.2
Requires-Dist: google-cloud-storage>=2.14.0
Requires-Dist: boto3>=1.34.103
Provides-Extra: dev
Requires-Dist: bump2version>=1.0.0; extra == "dev"
Requires-Dist: pre-commit>=2.6.0; extra == "dev"
Requires-Dist: ruff>=0.0.270; extra == "dev"
Requires-Dist: chispa>=0.9.2; extra == "dev"
Requires-Dist: coverage[toml]>=7.1.0; extra == "dev"
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pytest-mock>=3.8.0; extra == "dev"
Requires-Dist: moto>=5.0.7; extra == "dev"
Requires-Dist: black>=24.4.2; extra == "dev"
Requires-Dist: isort>=5.13.2; extra == "dev"
Provides-Extra: doc
Requires-Dist: mkdocs>=1.4.2; extra == "doc"
Requires-Dist: mkdocs-material>=9.5.38; extra == "doc"
Requires-Dist: mkdocstrings[python]>=0.22.0; extra == "doc"
Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.1; extra == "doc"
Requires-Dist: mkdocs-jupyter>=0.24.3; extra == "doc"
Requires-Dist: mkdocs-mermaid2-plugin>=1.1.1; extra == "doc"
Requires-Dist: pymdown-extensions>=10.11; extra == "doc"

# 🧰 diego-utils

[![Deploy MkDocs](https://github.com/diego-lda/diego-utils/actions/workflows/deploy_mkdocs.yaml/badge.svg?branch=main)](https://github.com/diego-lds/diego-utils/actions/workflows/deploy_mkdocs.yaml)
[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

The `diego-utils` package is a Python library with some utility functions that I find useful for data science and econometrics.
It is also a place for me to try and formalise some code built across different projects taht I think might be useful in the future.

It is built with Python 3.11 and higher, and uses `setup.py`, `setup.cfg`, and `pyproject.toml` for dependency management and packaging.

## 📋 Prerequisites

- Python 3.11 or higher

## 🛫 Set Up

`diego-utils` can be installed by first cloning the repository, navigating into the home directory and then running:

```bash
pip install .
```

This will install into your computer the `diego-utils` package.

## 🗂️ How the Project is Organised

The package has several modules, which split the functionality into themes:

- **metrics**: These are econometrics functions, to help with the analysis of data.
- **evaluate**: These are evaluation functions, designed to monitor a pipelines performance.
- **handle**: These are data handling functions, useful in data manipulation and transformation.

## 📖 Documentation and Further Information

The documentation is automatically generated using **GitHub Actions** and **MkDocs**.
For an in-depth understanding of `diego-utils`, how to contribute to `rdsa-utils`, and more, please refer to the [MkDocs-generated documentation](https://diego-lda.github.io/diego-utils/).

## 🛡️ Licence

Unless stated otherwise, the codebase is released under the [MIT License][mit].
This covers both the codebase and any sample code in the documentation.

[mit]: LICENSE
