Metadata-Version: 2.1
Name: Shimmy
Version: 2.0.0
Summary: An API conversion tool providing Gymnasium and PettingZoo bindings for popular external reinforcement learning environments.
Home-page: https://github.com/Farama-Foundation/Shimmy
Author: Farama Foundation
Author-email: contact@farama.org
Keywords: Reinforcement Learning,game,RL,AI
Classifier: Programming Language :: Python :: 3.8
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: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: numpy >=1.18.0
Requires-Dist: gymnasium >=1.0.0a1
Provides-Extra: all
Requires-Dist: gym >=0.26.2 ; extra == 'all'
Requires-Dist: dm-control >=1.0.10 ; extra == 'all'
Requires-Dist: imageio ; extra == 'all'
Requires-Dist: h5py >=3.7.0 ; extra == 'all'
Requires-Dist: pettingzoo >=1.23 ; extra == 'all'
Requires-Dist: dm-env >=1.6 ; extra == 'all'
Requires-Dist: open-spiel >=1.2 ; extra == 'all'
Requires-Dist: bsuite >=0.3.5 ; extra == 'all'
Requires-Dist: dm-meltingpot >=2.2.2 ; (python_version > "3.10") and extra == 'all'
Provides-Extra: bsuite
Requires-Dist: bsuite >=0.3.5 ; extra == 'bsuite'
Provides-Extra: dm-control
Requires-Dist: dm-control >=1.0.10 ; extra == 'dm-control'
Requires-Dist: imageio ; extra == 'dm-control'
Requires-Dist: h5py >=3.7.0 ; extra == 'dm-control'
Provides-Extra: dm-control-multi-agent
Requires-Dist: dm-control >=1.0.10 ; extra == 'dm-control-multi-agent'
Requires-Dist: imageio ; extra == 'dm-control-multi-agent'
Requires-Dist: h5py >=3.7.0 ; extra == 'dm-control-multi-agent'
Requires-Dist: pettingzoo >=1.23 ; extra == 'dm-control-multi-agent'
Provides-Extra: dm-lab
Requires-Dist: dm-env >=1.6 ; extra == 'dm-lab'
Provides-Extra: gym-v21
Requires-Dist: gym <0.26,>=0.21.0 ; extra == 'gym-v21'
Requires-Dist: pyglet ==1.5.11 ; extra == 'gym-v21'
Provides-Extra: gym-v26
Requires-Dist: gym >=0.26.2 ; extra == 'gym-v26'
Provides-Extra: meltingpot
Requires-Dist: pettingzoo >=1.23 ; extra == 'meltingpot'
Requires-Dist: dm-meltingpot >=2.2.2 ; (python_version > "3.10") and extra == 'meltingpot'
Provides-Extra: openspiel
Requires-Dist: open-spiel >=1.2 ; extra == 'openspiel'
Requires-Dist: pettingzoo >=1.23 ; extra == 'openspiel'
Provides-Extra: testing
Requires-Dist: pytest >=7.1.3 ; extra == 'testing'
Requires-Dist: pillow >=9.3.0 ; extra == 'testing'

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8140744.svg)](https://doi.org/10.5281/zenodo.8140744)

<p align="center">
    <img src="https://raw.githubusercontent.com/Farama-Foundation/Shimmy/main/shimmy-text.png" width="500px"/>
</p>

Shimmy is an API conversion tool providing [Gymnasium](https://github.com/farama-Foundation/gymnasium) and [PettingZoo](https://github.com/farama-Foundation/pettingZoo/) bindings for popular external reinforcement learning environments.

The documentation website is at [shimmy.farama.org](https://shimmy.farama.org/) and we have a public discord server (which we also use to coordinate development work) that you can join here: https://discord.gg/nhvKkYa6qX

## Supported APIs

