Skip to content

Installation#

You can install rbx with a single command, either using pip or pipx. Prefer using pipx to have a better isolation between the dependencies. Read more about pipx here.

Requirements#

  • Python 3.9.1 or above (stable with Python 3.10).
  • A C++ toolchain to compile testlib libraries (usually g++).
  • (Optional):
    • Compilers/interpreters that you need to run your solutions on (e.g. g++, java).
    • pdfLaTeX and other additional packages to convert TeX files into PDF (see https://www.latex-project.org/get/)

From PyPI#

$ pipx install rbx.cp

From the repository#

$ git clone https://github.com/rsalesc/rbx
$ cd rbx
$ pipx install .

Verify installation#

rbx --help# rbx help string should show up here

A note for Windows users#

rbx is not supported on Windows. One of the main reasons (but not the only one) is that rbx heavily uses symlinks, which is inherently a POSIX feature, and even though it's been implemented in Windows recently, it's not yet perfectly supported.

If you want to use rbx on Windows, you can do so by using the WSL (Windows Subsystem for Linux). Also, you'll have to make sure your packages are cloned within the WSL instance and filesystem. Cloning on a Windows folder and mounting it into the WSL instance will not work since symlinks will not be preserved.

Proceed to the Configuration section.