Environment¶
Whether you are contributing the RSSerpent core, or any of the official & community RSSerpent plugins, you need to follow this tutorial to set up a basic development environment.
Python¶
RSSerpent is written in the Python programming language. You must have a valid Python installation on your system in order to get RSSerpent up & run. The most universal way to install Python is to grab a installer from the official Python download page. An alternative approach is to install via a package manager:
# Arch
sudo pacman -S python
# Debian/Ubuntu
sudo apt update
sudo apt install python3 python3-pip
# Homebrew
brew install python
# MacPorts
sudo port selfupdate
sudo port install python
# Chocolatey
choco install python
# Scoop
scoop install python
Note
If you need to manage multiple versions of Python on your system, checkout pyenv.
Note
If you are using Windows, you will need to set the environment variable PYTHONIOENCODING=utf8.
After successful installation, you need to run python -V (or python3 -V) to verify the currently installed Python's version, as the default Python version provided by some package managers might not be compatible with RSSerpent. Please refer to the documentation of respective package manager to install a compatible Python version.
Note
Make sure you have git installed too.
Poetry¶
Poetry is a modern Python packaging and dependency management tool and is currently used by RSSerpent. To Install poetry please view:
https://github.com/python-poetry/install.python-poetry.org ```
Further Steps¶
- If you are contributing to the RSSerpent core, or an existing RSSerpent plugin project, please refer to Core;
- If you are starting a new RSSerpent plugin project, please refer to Plugin;