Metadata-Version: 2.1
Name: py-research
Version: 2.3.0
Summary: Collection of utilities for R&D coding in Python 🐍
Author-Email: Lorenzo Wormer <l.wormer@mailbox.org>
Requires-Python: <3.12,>=3.10
Requires-Dist: pandas<2.0.0,>=1.3.5
Requires-Dist: PyYAML<7.0,>=6.0
Requires-Dist: openpyxl<4.0.0,>=3.0.9
Requires-Dist: country-converter<1.0.0,>=0.7.4
Requires-Dist: pydantic<2.0.0,>=1.9.0
Requires-Dist: streamlit<2.0.0,>=1.7.0
Requires-Dist: tqdm<5.0.0,>=4.62.3
Requires-Dist: sqlalchemy<3.0.0,>=2.0.7
Requires-Dist: strenum<1.0.0,>=0.4.10
Requires-Dist: stqdm<1.0.0,>=0.0.5
Requires-Dist: structlog<24.0.0,>=23.1.0
Requires-Dist: webcolors<2.0,>=1.13
Requires-Dist: deep-translator<2.0.0,>=1.11.0
Requires-Dist: babel<3.0.0,>=2.12.1
Requires-Dist: numpy<2.0.0,>=1.24.3
Requires-Dist: deepmerge<2.0.0,>=1.1.0
Requires-Dist: pdfkit<2.0.0,>=1.0.0
Requires-Dist: imgkit<2.0.0,>=1.2.3
Requires-Dist: typing-extensions<5.0.0,>=4.7.1
Requires-Dist: plotly<6.0.0,>=5.16.1
Requires-Dist: GitPython>=3.1.40
Requires-Dist: beautifulsoup4>=4.12.2
Requires-Dist: importlib-metadata>=6.11.0
Requires-Dist: pandas-stubs>=2.1.4.231227
Description-Content-Type: text/markdown

# Py-Research

[![PyPI - Version](https://img.shields.io/pypi/v/py-research)](https://pypi.org/project/py-research)
[![Docs](https://github.com/cloudlane-one/py-research/actions/workflows/docs.yml/badge.svg)](https://cloudlane-one.github.io/py-research)
[![Tests](https://github.com/cloudlane-one/py-research/actions/workflows/lint-and-test.yml/badge.svg)](https://github.com/cloudlane-one/py-research/actions/workflows/lint-and-test.yml)
[![Build](https://github.com/cloudlane-one/py-research/actions/workflows/release.yml/badge.svg)](https://github.com/cloudlane-one/py-research/actions/workflows/release.yml)
[![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)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Codecov](https://codecov.io/gh/cloudlane-one/py-research/graph/badge.svg?token=J8GLAWTPWX)](https://codecov.io/gh/cloudlane-one/py-research)
[![CodeFactor](https://www.codefactor.io/repository/github/cloudlane-one/py-research/badge)](https://www.codefactor.io/repository/github/cloudlane-one/py-research)
[![CodeClimate Maintainability](https://api.codeclimate.com/v1/badges/4cc310489b325e793d1d/maintainability)](https://codeclimate.com/github/cloudlane-one/py-research/maintainability)

## About this project

This package contains multiple, related but not necessarily interdependent, modules meant to aid with automating and simplifying typical R&D coding workflows in Python.

## How to install

This package is available on PyPI:

```bash
pip install py-research
```

Alternatively, you can install it directly from git via:

```bash
pip install git+https://github.com/cloudlane-one/py-research.git
```

## Contents

```{toctree}
docs/ref-api/index
```

## Indices and Tables

- {ref}`genindex`
- {ref}`modindex`
- {ref}`search`
