Update CI, pre-commit and website (#121)

.github/ISSUE_TEMPLATE/bug.md

@@ -24,4 +24,4 @@ Add any other context about the problem here.
 
 ### Checklist
 
-- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/gym-miniworld/issues) in the repo (**required**)
+- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/miniworld/issues) in the repo (**required**)

.github/ISSUE_TEMPLATE/proposal.md

@@ -6,7 +6,7 @@ title: "[Proposal] Proposal title"
 
 
 
-### Proposal 
+### Proposal
 
 A clear and concise description of the proposal.
 
@@ -30,4 +30,4 @@ Add any other context or screenshots about the feature request here.
 
 ### Checklist
 
-- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/gym-miniworld/issues) in the repo (**required**)
+- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/miniworld/issues) in the repo (**required**)

.github/ISSUE_TEMPLATE/question.md

@@ -7,11 +7,11 @@ title: "[Question] Question title"
 
 ### Question
 
-If you're a beginner and have basic questions, please ask on 
-[r/reinforcementlearning](https://www.reddit.com/r/reinforcementlearning/) 
-or in the [RL Discord](https://discord.com/invite/xhfNqQv) 
-(if you're new please use the beginners channel). 
-Basic questions that are not bugs or feature requests will be closed without reply, 
+If you're a beginner and have basic questions, please ask on
+[r/reinforcementlearning](https://www.reddit.com/r/reinforcementlearning/)
+or in the [RL Discord](https://discord.com/invite/xhfNqQv)
+(if you're new please use the beginners channel).
+Basic questions that are not bugs or feature requests will be closed without reply,
 because GitHub issues are not an appropriate venue for these.
 
 Advanced/nontrivial questions, especially in areas where documentation is lacking, are very much welcome.

.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    # Look for GitHub Actions workflows in the `root` directory
+    directory: "/"
+    # Check the for updates once a week
+    schedule:
+      interval: "weekly"

.github/docker/testing-old.Dockerfile

@@ -0,0 +1,20 @@
+# A Dockerfile that sets up a full Gym install with test dependencies
+ARG PYTHON_VERSION
+FROM python:$PYTHON_VERSION
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+RUN apt-get -y update
+RUN apt-get install -y freeglut3-dev xvfb
+
+COPY ../.. /usr/local/miniworld/
+WORKDIR /usr/local/miniworld/
+
+RUN pip install .[testing] gymnasium==0.29.1 numpy==1.26.4
+
+RUN ["chmod", "+x", "/usr/local/miniworld/.github/docker/docker_entrypoint"]
+
+ENTRYPOINT ["/usr/local/miniworld/.github/docker/docker_entrypoint"]
+
+#RUN cd pytorch-a2c-ppo-acktr
+#RUN xvfb-run -a -s "-screen 0 1024x768x24 -ac +extension GLX +render -noreset" time python3 main.py --no-cuda --algo a2c --log-interval 1 --num-frames 200 --num-processes 1 --num-steps 80 --lr 0.00005 --env-name MiniWorld-Hallway-v0

py.Dockerfile → .github/docker/testing.Dockerfile

@@ -7,14 +7,14 @@ SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 RUN apt-get -y update
 RUN apt-get install -y freeglut3-dev xvfb
 
-COPY . /usr/local/miniworld/
+COPY ../.. /usr/local/miniworld/
 WORKDIR /usr/local/miniworld/
 
 RUN pip install .[testing] --no-cache-dir
 
-RUN ["chmod", "+x", "/usr/local/miniworld/bin/docker_entrypoint"]
+RUN ["chmod", "+x", "/usr/local/miniworld/.github/docker/docker_entrypoint"]
 
-ENTRYPOINT ["/usr/local/miniworld/bin/docker_entrypoint"]
+ENTRYPOINT ["/usr/local/miniworld/.github/docker/docker_entrypoint"]
 
 #RUN cd pytorch-a2c-ppo-acktr
 #RUN xvfb-run -a -s "-screen 0 1024x768x24 -ac +extension GLX +render -noreset" time python3 main.py --no-cuda --algo a2c --log-interval 1 --num-frames 200 --num-processes 1 --num-steps 80 --lr 0.00005 --env-name MiniWorld-Hallway-v0

.github/stale.yml

@@ -59,4 +59,4 @@ only: issues
 
 # issues:
 #   exemptLabels:
-#     - confirmed
+#     - confirmed

.github/workflows/build-docs-dev.yml

@@ -15,7 +15,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-            python-version: '3.9'
+            python-version: '3.11'
 
       - name: Install freeglut
         run: sudo apt-get install -y freeglut3-dev xvfb
@@ -49,4 +49,4 @@ jobs:
         with:
           folder: _build
           target-folder: main
-          clean: false
+          clean: false

.github/workflows/build-docs-version.yml

@@ -16,7 +16,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-            python-version: '3.9'
+            python-version: '3.11'
 
       - name: Get tag
         id: tag
@@ -62,4 +62,4 @@ jobs:
           folder: _build
           clean-exclude: |
             *.*.*/
-            main
+            main

.github/workflows/build-publish.yml

@@ -23,20 +23,11 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.x'
+          python-version: '3.11'
       - name: Install pypa/build
-        run: >-
-          python -m
-          pip install -U
-          build
+        run: python -m pip install -U build
       - name: Build a binary wheel and a source tarball
-        run: >-
-          python -m
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
+        run: python -m build --sdist --wheel --outdir dist/ .
       - name: Store wheels
         uses: actions/upload-artifact@v3
         with:

.github/workflows/manual-build-docs-version.yml

@@ -31,7 +31,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-            python-version: '3.9'
+            python-version: '3.11'
 
       - name: Install freeglut
         run: sudo apt-get install -y freeglut3-dev xvfb
@@ -74,4 +74,4 @@ jobs:
           folder: _build
           clean-exclude: |
             *.*.*/
-            main
+            main

.github/workflows/pre-commit.yml

@@ -11,4 +11,4 @@ jobs:
       - run: pip install pre-commit
       - run: pre-commit --version
       - run: pre-commit install
-      - run: pre-commit run --all-files
+      - run: pre-commit run --all-files

.github/workflows/build.yml → .github/workflows/pytest.yml

@@ -2,24 +2,35 @@ name: build
 on: [pull_request, push]
 
 jobs:
-  build:
+  build-latest:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
     steps:
       - uses: actions/checkout@v2
       - run: |
-           docker build -f py.Dockerfile \
+           docker build -f .github/docker/testing.Dockerfile \
              --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
-             --tag gym-miniworld-docker .
+             --tag miniworld-docker .
       - name: Run tests
-        run: docker run gym-miniworld-docker pytest
+        run: docker run miniworld-docker pytest
+
+  build-old:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          docker build -f .github/docker/testing-old.Dockerfile \
+            --build-arg PYTHON_VERSION='3.11' \
+            --tag miniworld-docker .
+      - name: Run tests
+        run: docker run miniworld-docker pytest
 
 # Old Travis testing
 
 # Test the simulator
 # xvfb-run -a -s "-screen 0 1024x768x24 -ac +extension GLX +render -noreset" ./run_tests.py
 #
 # Test RL code quickly
-# cd pytorch-a2c-ppo-acktr && xvfb-run -a -s "-screen 0 1024x768x24 -ac +extension GLX +render -noreset" time python3 main.py --no-cuda --algo a2c --log-interval 1 --num-frames 200 --num-processes 1 --num-steps 80 --lr 0.00005 --env-name MiniWorld-Hallway-v0
+# cd pytorch-a2c-ppo-acktr && xvfb-run -a -s "-screen 0 1024x768x24 -ac +extension GLX +render -noreset" time python3 main.py --no-cuda --algo a2c --log-interval 1 --num-frames 200 --num-processes 1 --num-steps 80 --lr 0.00005 --env-name MiniWorld-Hallway-v0

.pre-commit-config.yaml

@@ -1,18 +1,34 @@
 ---
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-ast
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: detect-private-key
+      - id: debug-statements
   - repo: https://github.com/python/black
-    rev: 23.3.0
+    rev: 24.10.0
     hooks:
       - id: black
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.4
+    rev: v2.3.0
     hooks:
       - id: codespell
         args:
           - --skip=*.svg
           # - --ignore-words-list=
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+    rev: 7.1.1
     hooks:
       - id: flake8
         args:
@@ -23,7 +39,7 @@ repos:
           - --show-source
           - --statistics
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         args: ["--profile", "black"]
@@ -37,10 +53,10 @@ repos:
 #          - --convention=google
 #        additional_dependencies: ["toml"]
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
-        args: ["--py37-plus"]
+        args: ["--py38-plus"]
 #  - repo: local
 #    hooks:
 #      - id: pyright

CODE_OF_CONDUCT.rst

@@ -65,5 +65,3 @@ Attribution
 -----------
 This Code of Conduct is adapted from `Python's Code of Conduct <https://www.python.org/psf/conduct/>`_, which is under a `Creative Commons License
 <https://creativecommons.org/licenses/by-sa/3.0/>`_.
-
-

README.md

@@ -10,9 +10,9 @@ Contents:
 - [Introduction](#introduction)
 - [Installation](#installation)
 - [Usage](#usage)
-- [Environments](docs/environments.md)
-- [Design and Customization](docs/content/design.md)
-- [Troubleshooting](docs/content/troubleshooting.md)
+- [Environments](https://miniworld.farama.org/content/env_list/)
+- [Design and Customization](https://miniworld.farama.org/content/design/)
+- [Troubleshooting](https://miniworld.farama.org/content/troubleshooting/)
 
 ## Introduction
 

docs/.gitignore

@@ -1,2 +1,2 @@
 environments/**/*.md
-content/env_list.html
+content/env_list.html

docs/404.md

@@ -1,3 +1,3 @@
 # 404 - Page Not Found
 
-## The requested page could not be found.
+## The requested page could not be found.

docs/_scripts/gen_env_docs.py

@@ -3,7 +3,9 @@
 
 import gymnasium as gym
 
-import miniworld  # noqa: F401
+import miniworld
+
+gym.register_envs(miniworld)
 
 
 # From python docs
@@ -75,7 +77,6 @@ def trim(docstring):
 |---|---|
 | Action Space | `{re.sub(' +', ' ', action_space_table)}` |
 | Observation Space | `{re.sub(' +', ' ', observation_space_table)}` |
-| Reward Range | `{env.reward_range}` |
 | Creation | `gymnasium.make("{env_spec.id}")` |
 """
         res_env_md += f"{env_attributes}\n"

docs/_scripts/gen_envs_display.py

@@ -2,16 +2,18 @@
 
 import gymnasium as gym
 
-import miniworld  # noqa: F401
+import miniworld
+
+gym.register_envs(miniworld)
 
 
 def create_grid_cell(env_id):
     env_name = env_id.split("-")[-2]
     return f"""
-            <a href="/environments/{env_name.lower()}">
+            <a href="../environments/{env_name.lower()}.html">
                 <div class="env-grid__cell">
                     <div class="cell__image-container">
-                        <img src="/_static/environments/{env_name.lower()}.jpg">
+                        <img src="../_static/environments/{env_name.lower()}.jpg">
                     </div>
                     <div class="cell__title">
                         <span>{env_name}</span>

docs/content/create_env.md

@@ -49,7 +49,7 @@ which places the goal in the middle. Now the environment should look like this:
 :width: 500px
 ```
 
-### Add reward 
+### Add reward
 
 To add a reward when the agent gets close to the box, we can do the following: