Metadata-Version: 2.3
Name: oi-tools
Version: 0.10.2
Summary: Python package for Opportunity Insights.
Author: The Opportunity Insights Team, Alistair Pattison
Author-email: The Opportunity Insights Team <info@opportunityinsights.org>, Alistair Pattison <alistairpattison@gmail.com>
Requires-Dist: humanfriendly>=10.0
Requires-Dist: inflection>=0.5.1
Requires-Dist: polars>=1.32.0
Requires-Dist: rich>=14.1.0
Requires-Dist: cyclopts>=3.0.0
Requires-Dist: joblib>=1.5.3
Requires-Dist: httpx>=0.28.1
Requires-Dist: us>=3.2.0
Requires-Dist: parsel>=1.10.0
Requires-Dist: polars-ols>=0.3.5
Requires-Dist: xlsxwriter>=3.2.9
Requires-Dist: fastexcel>=0.16.0
Requires-Dist: plotnine>=0.13.6 ; extra == 'plotnine'
Requires-Python: >=3.9
Project-URL: Documentation, https://opportunityinsights.github.io/oi-tools/
Project-URL: Homepage, https://github.com/OpportunityInsights/oi-tools
Provides-Extra: plotnine
Description-Content-Type: text/markdown

# oi-tools

[![PyPI version](https://img.shields.io/pypi/v/oi-tools)](https://pypi.org/project/oi-tools/)
[![docs](https://img.shields.io/badge/docs-latest-blue)](https://opportunityinsights.github.io/oi-tools)
[![Lint, type check, and test](https://github.com/OpportunityInsights/oi-tools/actions/workflows/tests.yml/badge.svg)](https://github.com/OpportunityInsights/oi-tools/actions/workflows/tests.yml)

This package has two main parts:

1. Python helper functions for common tasks at Opportunity Insights and
2. A CLI (`oi --help`) for submitting and monitoring PBS jobs and viewing the package documentation while offline.

See [the documentation](https://opportunityinsights.github.io/oi-tools) for more info about each of these.

## Installation

To install the most recent version of the package from PyPI:

```bash
# using uv (recommended)
uv add oi-tools

# using pip
pip install oi-tools
```
To install the most-recent development version from git:

```bash
uv add git+https://github.com/OpportunityInsights/oi-tools
pip install git+https://github.com/OpportunityInsights/oi-tools
```

To include the optional plotnine dependency, install `oi-tools[plotnine]`.
At the moment, we support Python 3.9 and newer.

## Contributing

We welcome contributions in the form of bug reports, feature requests, and PRs.
See [the contribution guidelines](https://opportunityinsights.github.io/oi-tools/contributing.html) for info about PR contributions.

