Installation#

To avoid the pitfalls of using system package managers for installing/managing Python, we recommend you to check out pyenv (Linux) or pyenv-win (Windows).

For now, RELSAD supports the following Python versions:

  • 3.8

  • 3.9

  • 3.10

Stable release#

To install RELSAD, run this command in your terminal:

$ python -m pip install --upgrade pip
$ python -m pip install relsad

This is the preferred method to install RELSAD, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources#

The sources for RELSAD can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/stinefm/relsad

Or download the tarball:

$ curl  -OL https://github.com/stinefm/relsad/tarball/main

Once you have a copy of the source, you can install it. The method of installation will depend on the packaging library being used.

The packaging and dependency management of RELSAD is done through poetry. Follow the poetry installation guide for installation details.

Install RELSAD in developer mode using poetry:

$ cd relsad
$ poetry install

Test the package#

If you installed RELSAD from source, you should run the tests to validate the installation. This is done by calling pytest from the repo:

$ cd relsad
$ poetry run pytest