PyRat

This repository contains the software used in the
computer science course at IMT Atlantique.

The course is available at this address:
https://hub.imt-atlantique.fr/ueinfo-fise1a.

The documentation is available at this address:
https://bastienpasdeloup.github.io/PyRat.

Prerequisites

This installation procedure assumes that you have basic knowledge about shell manipulation.
PyRat uses uv to manage Python and the libraries it needs.
You do not need to install Python yourself: uv takes care of it, and PyRat workspaces are configured to use Python 3.13 (Python 3.12 is also supported).
Finally, we will test PyRat installation using Visual Studio Code (VSCode), as this is the main tool we use in the associated course. Please make sure it is already installed, or install it from the official website. Note that you can use a different tool if you want, but we just provide indications for that one here.

Install uv

If uv is not installed on your machine yet, install it as follows:

Linux: curl -LsSf https://astral.sh/uv/install.sh | sh.
MacOS: curl -LsSf https://astral.sh/uv/install.sh | sh.
Windows (PowerShell): powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex".

Other installation methods are described in the uv documentation.
Then, close and reopen your terminal, and check that uv is available by running uv --version.

Setup your PyRat workspace

We are now going to create a workspace for PyRat.
This is a directory that contains minimal working examples to get started, and in which PyRat is installed.
To do so, follow these steps:

Open a terminal, and navigate (use the cd command) to the directory where you want to create your PyRat workspace.
Run the following command (it is the same on all systems): uvx --from pyrat-game pyrat-init.

You should see something like this:

Workspace created in /path/to/pyrat_workspace, as a uv project using Python >=3.12,<3.14
Git repository created for the workspace
Using CPython 3.13.13
Creating virtual environment at: .venv
Resolved 20 packages in 178ms
Installed 19 packages in 45ms
Virtual environment created, with PyRat installed in it
Your workspace is ready! You can now start coding your players and run games.
To run a game, go to the workspace using 'cd pyrat_workspace', then use for instance 'uv run games/sample_game.py'.

You should have a new directory called pyrat_workspace in the directory where you ran the command.
It contains a players directory and a games directory, which is where your own programs live.
If you prefer another name for the workspace, pass it to the command, as in uvx --from pyrat-game pyrat-init my_project.

Check your installation

Now, we are going to verify that PyRat works properly.
To do so, follow these steps:

Open a terminal, and navigate to your workspace using cd pyrat_workspace.
Run the sample game as follows: uv run games/sample_game.py.

You can also run your games from VSCode.
To do so, follow these steps:

Open VSCode, and add your pyrat_workspace directory in your VSCode workspace.
Open the file sample_game.py in directory games/.
Make sure VSCode is using the interpreter located in the .venv directory of your workspace.
Run sample_game.py.

In both cases, you should see something like this:

Add other libraries to your workspace

Your workspace is a uv project, so you can add any library you need to it.
To do so, run uv add from your workspace, as in uv add numpy.
The library is then available in your players and games, with no need to activate anything.

Rebuild your workspace

A workspace describes everything it needs in its pyproject.toml and uv.lock files, so it can always be rebuilt.
Run this from the workspace, for instance after cloning it on another machine, or if one of its libraries goes missing:

uv sync

This installs again everything the workspace declares, in a virtual environment created for the machine it runs on.

Renaming or moving a workspace needs nothing: its programs keep importing each other, wherever the workspace is.

Troubleshooting

In case of a problem, please check the existing GitHub issues first.
If the problem persists, you can add an issue of your own.
For students at IMT Atlantique, you can also ask your questions on the Discord server of the course.
Finally, you can contact Bastien Pasdeloup directly.

Metadata

Release files for pyrat-game 6.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyrat-game 6.5.1
File	Size	Uploaded
pyrat_game-6.5.1.tar.gz	4.2 MB	Sep 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pyrat-game 6.5.1
File	Interpreter	ABI	Platform	Reset
pyrat_game-6.5.1-py3-none-any.whl 4.3 MB Sep 23, 2026	Python 3	none	any	Details

Total release size: 8.5 MB

Release files / pyrat_game-6.5.1.tar.gz

Download URL	pyrat_game-6.5.1.tar.gz
Size	4.2 MB
Tags	Source
SHA-256 checksum How to use checksums	`dc95b592681332618c249d5251354ea55e1162c3535f784da1d969344b4e9aff`
BLAKE2b-256 checksum How to use checksums	`b430090c50d327e56ca65be09348a8bd63220e99682617ae383e74382684c803`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/BastienPasdeloup/PyRat
Publishing commit: github.com/BastienPasdeloup/PyRat/tree/e58d2248fd54f3e0e043162d1d821cfd69395362

Workflow

Publishing configuration: github.com/BastienPasdeloup/PyRat/blob/e58d2248fd54f3e0e043162d1d821cfd69395362/.github/workflows/publish_to_pypi.yml
Publishing logs: github.com/BastienPasdeloup/PyRat/actions/runs/35840734958/attempts/1

Artifact

Subject: pyrat_game-6.5.1.tar.gz
SHA-256 checksum: dc95b592681332618c249d5251354ea55e1162c3535f784da1d969344b4e9aff Verifying attestations

Release files / pyrat_game-6.5.1-py3-none-any.whl

Download URL	pyrat_game-6.5.1-py3-none-any.whl
Size	4.3 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`50bbebf24320560e7dd8f167f117b6358f02ee8f16e1742005604108d00f758c`
BLAKE2b-256 checksum How to use checksums	`f54973256c7814bf9b6057d0c0157b831153d00391fe5ea1c076a530ba24d8b1`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/BastienPasdeloup/PyRat
Publishing commit: github.com/BastienPasdeloup/PyRat/tree/e58d2248fd54f3e0e043162d1d821cfd69395362

Workflow

Publishing configuration: github.com/BastienPasdeloup/PyRat/blob/e58d2248fd54f3e0e043162d1d821cfd69395362/.github/workflows/publish_to_pypi.yml
Publishing logs: github.com/BastienPasdeloup/PyRat/actions/runs/35840734958/attempts/1

Artifact

Subject: pyrat_game-6.5.1-py3-none-any.whl
SHA-256 checksum: 50bbebf24320560e7dd8f167f117b6358f02ee8f16e1742005604108d00f758c Verifying attestations