Metadata-Version: 2.4
Name: koop
Version: 0.0.2
Summary: A package for interfacing with koordinates.
Project-URL: Source Code, https://github.com/tonkintaylor/YOUR_REPOSITORY
Project-URL: Bug Tracker, https://github.com/tonkintaylor/YOUR_REPOSITORY/issues
Project-URL: Releases, https://github.com/tonkintaylor/YOUR_REPOSITORY/releases
Project-URL: Source Archive, https://github.com/tonkintaylor/YOUR_REPOSITORY/archive/1abd55c956c0155b94f5428f10a52cdde35dabf2.zip
Author-email: Bilbo Baggins <bbaggins@tonkintaylor.co.nz>
Maintainer-email: Data + Analytics <Sub-DisciplineData+AnalyticsStaff@tonkintaylor.co.nz>
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: defusedxml>=0.7.1
Requires-Dist: pydantic>=2.0.0
Requires-Dist: requests>=2.0.0
Description-Content-Type: text/markdown

# Koop

A package for interfacing with Koordinates.

## Installation

Install the package from PyPI:

```bash
pip install koop
```

## Configuration

The following environment variables are required:

- `KOORDINATES_API_KEY`: Your Koordinates API key.
- `KOOPCACHE_DIR`: Directory to store cached layers.

## Usage

### Get a Layer

You can download and cache a layer using its ID:

```python
from koop import get_layer_from_id

# Returns a Path object to the downloaded Geopackage
layer_path = get_layer_from_id(
    layer_id=123,
    api_key="your-api-key"
)
```

## License

MIT License
