migrate to gymnasium (#239)

README.md

@@ -135,7 +135,7 @@ These values are **not pixels**. If you want to obtain an array of RGB pixels as
 use the `RGBImgPartialObsWrapper`. You can use it as follows:
 
 ```python
-import gym
+import gymnasium as gym
 from minigrid.wrappers import RGBImgPartialObsWrapper, ImgObsWrapper
 
 env = gym.make('MiniGrid-Empty-8x8-v0')

minigrid/__init__.py

@@ -1,4 +1,4 @@
-from gym.envs.registration import register
+from gymnasium.envs.registration import register
 
 from minigrid import minigrid, roomgrid, wrappers
 

minigrid/envs/dynamicobstacles.py

@@ -1,6 +1,6 @@
 from operator import add
 
-from gym.spaces import Discrete
+from gymnasium.spaces import Discrete
 
 from minigrid.minigrid import Ball, Goal, Grid, MiniGridEnv, MissionSpace
 

minigrid/examples/benchmark.py

@@ -2,7 +2,7 @@
 
 import time
 
-import gym
+import gymnasium as gym
 
 from minigrid.wrappers import ImgObsWrapper, RGBImgPartialObsWrapper
 

minigrid/examples/manual_control.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-import gym
+import gymnasium as gym
 
 from minigrid.window import Window
 from minigrid.wrappers import ImgObsWrapper, RGBImgPartialObsWrapper

minigrid/minigrid.py

@@ -4,10 +4,10 @@ from abc import abstractmethod
 from enum import IntEnum
 from typing import Any, Callable, Optional, Union
 
-import gym
+import gymnasium as gym
 import numpy as np
-from gym import spaces
-from gym.utils import seeding
+from gymnasium import spaces
+from gymnasium.utils import seeding
 
 # Size in pixels of a tile in the full-scale human view
 from minigrid.rendering import (

minigrid/wrappers.py

@@ -2,10 +2,10 @@ import math
 import operator
 from functools import reduce
 
-import gym
+import gymnasium as gym
 import numpy as np
-from gym import spaces
-from gym.core import ObservationWrapper, Wrapper
+from gymnasium import spaces
+from gymnasium.core import ObservationWrapper, Wrapper
 
 from minigrid.minigrid import COLOR_TO_IDX, OBJECT_TO_IDX, STATE_TO_IDX, Goal
 

requirements.txt

@@ -1,3 +1,3 @@
 numpy>=1.18.0
-gym>=0.26
+gymnasium>=0.26
 matplotlib>=3.0

setup.py

@@ -27,17 +27,19 @@ setup(
         "Programming Language :: Python :: 3.10",
     ],
     version="1.2.1",
-    keywords="memory, environment, agent, rl, gym",
+    keywords="memory, environment, agent, rl, gymnasium",
     url="https://github.com/Farama-Foundation/MiniGrid",
     description="Minimalistic gridworld reinforcement learning environments",
     extras_require=extras,
     packages=["minigrid", "minigrid.envs"],
-    entry_points={"gym.envs": ["__root__ = minigrid.__init__:register_minigrid_envs"]},
+    entry_points={
+        "gymnasium.envs": ["__root__ = minigrid.__init__:register_minigrid_envs"]
+    },
     license="Apache",
     long_description=long_description,
     long_description_content_type="text/markdown",
     install_requires=[
-        "gym>=0.26",
+        "gymnasium>=0.26",
         "numpy>=1.18.0",
         "matplotlib>=3.0",
     ],

tests/test_envs.py

@@ -1,10 +1,10 @@
 import warnings
 
-import gym
+import gymnasium as gym
 import numpy as np
 import pytest
-from gym.envs.registration import EnvSpec
-from gym.utils.env_checker import check_env
+from gymnasium.envs.registration import EnvSpec
+from gymnasium.utils.env_checker import check_env
 
 from minigrid.minigrid import Grid, MissionSpace
 from tests.utils import all_testing_env_specs, assert_equals

tests/test_scripts.py

@@ -1,4 +1,4 @@
-import gym
+import gymnasium as gym
 import numpy as np
 
 from minigrid.examples.benchmark import benchmark

tests/test_wrappers.py

@@ -1,6 +1,6 @@
 import math
 
-import gym
+import gymnasium as gym
 import numpy as np
 import pytest
 

tests/utils.py

@@ -1,5 +1,5 @@
 """Finds all the specs that we can test with"""
-import gym
+import gymnasium as gym
 import numpy as np
 
 all_testing_env_specs = [