Installation Guide

Python Versions

RSTT requires Python 3.10+.

Installation

You can install RSTT from PyPI with:

pip install rstt

Dependencies

RSTT relies on the following Python packages:

  • names — provides random names for players.

  • typeguard — for runtime type-checking.

  • numpy — as a computing tool.

Integration

RSTT was developed with the intent to be used alongside other packages for testing. You can integrate it into your simulation rating system like:

Developer

RSTT is open source and welcomes contributions. Once you have read the guidelines, you can start working.

  1. Get the code:

    git clone https://github.com/Ematrion/rstt.git
    

    and then:

    cd rstt
    
  2. Install Dependencies with Poetry

    The project is built using poetry. If you also use it, simply run:

    poetry install --with dev
    
  3. Alternative Installation

    If you don’t use Poetry, you need to perform the steps manually:

    1. Create a virtual environment:

      python -m venv .venv
      
    2. Activate it:

      • On macOS/Linux:

      source .venv/bin/activate
      
      • On Windows:

      .venv\Scripts\activate
      
    3. Install dependencies:

      pip install --editable '.[dev]'
      
  4. Check Your Installation

    Make sure everything works fine by running the tests with:

    pytest