oi-tools

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 for more info about each of these.

Installation

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

# using uv (recommended)
uv add oi-tools

# using pip
pip install oi-tools

To install the most-recent development version from git:

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 for info about PR contributions.

For more information about setting up a Python project, see the project setup page.

Getting Started

• Project Setup
• Using the CLI
• Contributing

Polars Utilities

• Weighted Statistics
• Convenience Functions
• Reading and Writing Files
• Census Bureau API

Census Utilities

• PBS Queue Management
• Census Disclosure

Making and Saving Figures

• Figures