Pyproject Update & README Improvement #22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added missing Gymnasium project dependency, and tighter constraints on Python version. See drubinstein#19
Specific instructions around build-essentials required for compiling from dependencies from source. Clarified supported Python. More detailed instructions on installation and setup.
Contributor
|
This should be merged imo. I tried using Python 3.12 & 3.13 at first, and can concur that it causes issues. Python 3.11.12 worked for me. |
drubinstein
reviewed
Dec 3, 2025
Comment on lines
+23
to
+81
| #### 🐧 Ubuntu / Debian | ||
|
|
||
| You will need to add a PPA for Python versions which are not the latest and update your package list before being able to install Python3.10/Python3.11. | ||
|
|
||
| ```bash | ||
| sudo add-apt-repository ppa:deadsnakes/ppa | ||
| sudo apt update | ||
| sudo apt install python3.11-dev build-essential | ||
| ``` | ||
|
|
||
| > Replace `python3.11-dev` with the appropriate version for your system if using a different Python version. E.g Python3.10 | ||
|
|
||
| #### 🐧 Arch Linux / Manjaro | ||
|
|
||
| Arch Linux provides only the latest version of Python, so you must use the **AUR** (Arch User Repository) to install Python 3.10/Python 3.11. | ||
|
|
||
| Install an AUR helper like `yay` if you haven’t already: | ||
|
|
||
| ```bash | ||
| sudo pacman -S --needed git base-devel | ||
| git clone https://aur.archlinux.org/yay.git | ||
| cd yay | ||
| makepkg -si | ||
| ``` | ||
|
|
||
| Install the aur package [Python 3.11](https://aur.archlinux.org/packages/python311) | ||
| ```bash | ||
| yay -S python311 | ||
| ``` | ||
| --- | ||
|
|
||
| ### 🔧 Fix: antlr4-python3-runtime Build Issues | ||
|
|
||
| Before installing, **upgrade `pip` and `setuptools`** to avoid errors when building some dependencies (like `antlr4-python3-runtime`): | ||
|
|
||
| ```bash | ||
| pip install --upgrade pip setuptools | ||
| ``` | ||
|
|
||
| This resolves errors such as: | ||
|
|
||
| ``` | ||
| AttributeError: install_layout. Did you mean: 'install_platlib'? | ||
| ``` | ||
|
|
||
| > ⚠️ You may still see a warning about `setup.py install` being deprecated — this can usually be ignored if installation completes. | ||
|
|
||
| --- | ||
|
|
||
| ### 🐍 (Optional) Virtual Environment Setup & Sourcing | ||
|
|
||
| Creating a virtual environment helps isolate dependencies, and prevent system-wide conflicts. The following will create a folder `.venv` for your dependencies. You should source this everytime. | ||
|
|
||
| ```bash | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate | ||
| ``` | ||
|
|
||
| Ensure `python3` points to Python 3.11 or earlier. |
Owner
There was a problem hiding this comment.
Please remove this. I'd rather the instructions simply point to uv
| "websockets" | ||
| ] | ||
| requires-python = ">= 3.10" | ||
| requires-python = ">= 3.10, < 3.12" |
Owner
There was a problem hiding this comment.
If you make a pr with just this one line, I'll take it.
Contributor
There was a problem hiding this comment.
I will do this now, thank you!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Python constraint (<3.12) & gymnasium package added to Pyproject.toml. Updated the readme to include more detailed setup and build instructions including build dependencies and procedures.
Fixes #19