1. Installation

RP Scripts is a Python-3-based program. The easiest way to install RP Scripts is using the PIPX package manager to get and install it from its source code from GitHub.

The installation process consists of:

  • Install Python 3

  • Install an auxiliary package manager (homebrew for MacOS or scoop for Windows)

  • Install PIPX

  • Install GIT

  • Install RP Scripts

  • Install Graphviz

1.1. Python 3

To check Python 3 availability, open a terminal (power shell on Windows) and run the following command:

python --version

To install Python 3, check its documentation.

1.2. Auxiliary package manager

1.2.1. Linux

Most Linux distros have package managers. For instance, apt in Debian-based, dnf in RedHat, pacman in ArchLinux, etc.

1.2.2. MacOS

Mac users need to install the Homebrew package manager:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

1.2.3. Windows

Windows users need to open a PowerShell terminal and install the Scoop command installer:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression

1.3. PIPX

PIPX installation consists of two steps: the program installation and the path configuration.

1.3.1. Linux

Open a terminal and run the following commands:

sudo apt install pipx
pipx ensurepath

1.3.2. MacOS

Open a terminal and run the following commands:

brew install pipx
pipx ensurepath

1.3.3. Windows

Open a PowerShell and run the following commands:

scoop install pipx
pipx ensurepath

1.4. GIT

See GIT documentation at https://git-scm.com/book/en/v2/Getting-Started-Installing-Git.

1.4.1. Linux

Open a terminal and run the following commands:

sudo apt install git-all

1.4.2. MacOS

Open a terminal and run the following commands:

brew install git

1.4.3. Windows

Get the binary at https://git-scm.com/downloads/win and install.

1.5. RP Scripts

The next step is to use PIPX to install RP Scripts.

For the stable version:

pipx install git+https://github.com/msampaio/rpScripts.git

For the development version:

pipx install git+https://github.com/msampaio/rpScripts.git@dev

1.6. Graphviz

The TClass program needs Graphviz.

1.7. Install checking

For the install checking, run:

rpscripts -h