Metadata-Version: 2.4
Name: prpl_utils
Version: 0.0.2
Summary: Common Python utilities for the Princeton Robot Planning and Learning lab.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: graphviz
Requires-Dist: pyperplan
Requires-Dist: gymnasium
Requires-Dist: moviepy
Provides-Extra: develop
Requires-Dist: black; extra == "develop"
Requires-Dist: docformatter; extra == "develop"
Requires-Dist: isort; extra == "develop"
Requires-Dist: mypy; extra == "develop"
Requires-Dist: pylint>=2.14.5; extra == "develop"
Requires-Dist: pytest-pylint>=0.18.0; extra == "develop"
Requires-Dist: pytest>=7.2.2; extra == "develop"
Dynamic: license-file

# PRPL Utils

Miscellaneous Python utilities from the Princeton Robot Planning and Learning group.
- **Motion planning**: RRT, BiRRT
- **PDDL planning**: interfaces to pyperplan, Fast Downward
- **Heuristic search**: A*, GBFS, hill-climbing, policy-guided A*
- **Gymnasium**: agent interface, helper spaces
- **Other**: a few other miscellaneous utils

## Requirements

- Python 3.10+
- Tested on MacOS Monterey and Ubuntu 22.04

## Installation

1. Recommended: create and source a virtualenv.
2. `pip install -e ".[develop]"`

## Check Installation

Run `./run_ci_checks.sh`. It should complete with all green successes in 5-10 seconds.

## Contributing

Pull requests welcome. Note that this is meant to be a **lightweight** package. For example, it should be safe to use in homework assignments with minimal assumptions about the user's setup. Do not add heavy-duty dependencies.
