Install offsets-db-data

Installing the package

pip

$ python -m pip install offsets-db-data

pixi

Add to an existing Pixi project:

$ pixi add --pypi offsets-db-data

uv

Add to an existing uv project:

$ uv add offsets-db-data

Or install directly into a virtual environment:

$ uv pip install offsets-db-data

Development setup

To contribute to offsets-db-data, clone the repository and set up the full development environment using Pixi. Install Pixi first by following the installation instructions.

Pixi (recommended)

$ git clone https://github.com/carbonplan/offsets-db-data
$ cd offsets-db-data
$ pixi install

Run common tasks with pixi run <task>:

$ pixi run test              # run unit tests
$ pixi run test-cov          # run unit tests with coverage
$ pixi run test-integration  # run integration tests (requires S3 + OpenRefine)
$ pixi run test-all          # run unit + integration tests
$ pixi run lint              # lint
$ pixi run format            # format code
$ pixi run format-check      # check formatting
$ pixi run docs-build        # build documentation

Activate an interactive shell with all dependencies:

$ pixi shell

pip

$ git clone https://github.com/carbonplan/offsets-db-data
$ cd offsets-db-data
$ python -m pip install -e ".[dev]"