Metadata-Version: 2.3
Name: oi-tools
Version: 0.1.2
Summary: Add your description here
Author: Alistair Pattison
Author-email: Alistair Pattison <alistairpattison@gmail.com>
Requires-Dist: humanfriendly>=10.0
Requires-Dist: polars>=1.32.0
Requires-Dist: rich>=14.1.0
Requires-Dist: typer>=0.16.0
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# oi-tools

This package 

## Installation

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

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

# using pip
pip install oi-utils
```

We require at least Python 3.9.

## Usage

See the `examples` directory for usage examples (documentation coming soon).

## Contributing

To reduce the accumulation of slop, write access is blocked on the `main` branch.
To contribute, you must open a PR and have at least one other person approve your changes.

For example, using the `gh` command-line tool:

```bash
# get the repo
gh repo clone opportunityinsights/oi-tools
cd oi-tools

# make a new branch
git branch new-feature
git switch new-feature

# open in vscode to make your changes!
code .

# create a pr on the github website to merge your new branch into main
# gh pr create --web
