Installing `check-datapackage`

Before installing check-datapackage, 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 in a project (recommended)

It’s generally recommended to install Python packages in a project’s virtual environment to keep the project’s dependencies isolated from the system-wide Python setup and avoid conflicts. There are several tools to manage package dependencies and create virtual environments, such as venv, virtualenv, and uv. For this guide, we will use uv.

If you don’t have uv installed, you can install it in your Terminal with pipx:

Terminal

pipx install uv

To check that uv is installed, run this command:

Terminal

uv

If you get a list of uv commands, you’ve installed it successfully.

Then, create a Python project using uv by running the following command in your Terminal (replace <project-name> with your desired project name, e.g., diabetes-study):

Terminal

uv init <project-name>

This will create a new directory with the project name you provided with the basic structure of a Python project, including a pyproject.toml file.

With uv installed, you can now install check-datapackage directly from the GitHub repository with this command:

Terminal

uv add "check-datapackage @ git+https://github.com/seedcase-project/check-datapackage"

You can check that check-datapackage has been installed correctly by running this command:

Terminal

uv pip show check-datapackage

If check-datapackage has been installed successfully, the output will show details about check-datapackage.

Install system-wide

We strongly recommend using check-datapackage in a virtual environment (as described in the section above), but you can also install it system-wide. The easiest way to do that is to use pipx:

Terminal

pipx install check-datapackage

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

Terminal

pipx list

Now you can use check-datapackage in any Python script on your computer.