Metadata-Version: 2.4
Name: shaperl
Version: 0.1.0
Summary: Support for using shape and geometry in reinforcement learning environments
Project-URL: Homepage, https://github.com/jcarlson212/shaperl
Project-URL: Repository, https://github.com/jcarlson212/shaperl
Project-URL: Issues, https://github.com/jcarlson212/shaperl/issues
Author: Jason Carlson
License-Expression: MIT
License-File: LICENSE
Keywords: geometry,reinforcement-learning,rl,shape
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest>=7; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# shaperl

Support for using shape and geometry in reinforcement learning environments

> ⚠️ **Early development.** `shaperl` is pre-1.0 and under active development. The API is
> incomplete and may change without warning between releases. Pin an exact version if you
> depend on it, and expect breaking changes.

## Installation

```bash
pip install shaperl
```

## Usage

```python
import shaperl

print(shaperl.__version__)
```

## Development

```bash
python -m pip install -e ".[dev]"
pytest
```

## Releasing

Releases publish to PyPI via [trusted publishing](https://docs.pypi.org/trusted-publishers/)
(OIDC — no API tokens stored in the repo).

1. Bump `__version__` in `src/shaperl/__init__.py`.
2. Commit, then tag with a matching `v` prefix and push:

   ```bash
   git tag v0.1.0
   git push origin v0.1.0
   ```

The `Release` workflow builds the sdist and wheel, verifies the tag matches the package
version, and publishes to PyPI.

## License

MIT — see [LICENSE](LICENSE).
