Metadata-Version: 2.4
Name: orcapod-types
Version: 0.0.0
Summary: A collection of Orcapod content-based data types.
Project-URL: Homepage, https://github.com/nauticalab/orcapod-python-types
Project-URL: Repository, https://github.com/nauticalab/orcapod-python-types
Project-URL: Issues, https://github.com/nauticalab/orcapod-python-types/issues
Author: Nauticalab
License: MIT
Keywords: content-addressed,data,orcapod,types
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# orcapod-types

A collection of [Orcapod](https://github.com/nauticalab) content-based data types.

This package provides the shared, content-addressed data types used across the
Orcapod ecosystem. It is intended to be a lightweight, dependency-free foundation
that other Orcapod packages can build on.

> **Status:** early development. This is a placeholder (`0.0.0`) release to
> establish the package name and structure; the types are still being designed.

## Installation

```bash
uv add orcapod-types
```

Or with pip:

```bash
pip install orcapod-types
```

## Usage

```python
import orcapod_types

print(orcapod_types.__version__)
```

## Development

This project uses [`uv`](https://docs.astral.sh/uv/) for environment and
dependency management.

```bash
# Set up the environment
uv sync

# Run the test suite
uv run pytest

# Format and lint
uv run ruff format .
uv run ruff check --fix .

# Type-check
uv run pyright
```

## License

MIT © Nauticalab
