Installing Sprout

Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

Important

Sprout assumes you have control over your system’s files and folders, or at least your user’s home directory. This includes having access to a server through the Terminal where you can write to specific folders.

Before installing Sprout, you need to have Python and pipx installed.

To check that these programs are installed, run the following commands in your Terminal:

Terminal
python3 --version
pipx --version

If Python and pipx are installed, these commands will show you the versions installed on your system. If you get an error, you need to install them before continuing.

Install Sprout in system-wide

We strongly recommend using Sprout in a virtual environment, but you can also install it system-wide. The easiest way to do that is to use pipx:

Terminal
pipx install git+https://github.com/seedcase-project/seedcase-sprout.git

To check that Sprout has been installed correctly, run the following and make sure seedcase_sprout is listed:

Terminal
pipx list

Now you can use Sprout in any Python script throughout your computer.