Installing Sprout

Install Sprout to use on the command-line and in Python projects.

Before installing Sprout, you need uv installed. To check that it is available, run:

Terminal

uv --version

The command should print a version number. If you get an error instead, install uv before continuing.

Install globally

Installing Sprout globally lets you run it from any directory on your machine. To install globally, run:

Terminal

uv tool install seedcase-sprout

Once installed, you can run the program with seedcase-sprout (or sprout for short). Alternatively, use uvx to run Sprout without having to separately install it first—this always fetches the latest version:

Terminal

uvx seedcase-sprout

Install in a Python project

Installing Sprout in a project’s virtual environment keeps its dependencies contained within the project and not available throughout the system.

We assume you’ve already created a Python project with a pyproject.toml file. We recommend creating a Python project using our template data package.

From your project’s directory, run:

Terminal

uv add seedcase-sprout

To verify the installation, run:

Terminal

uv pip show seedcase-sprout

If successful, the output will show details about the installed package and you’re now ready to use Sprout in your project!