Installation#

The DSO CLI is available from PyPI. The package is named dso-core You can think of it as the “core” package of DSO, while there is also a separate R package and there might be other “extension” packages in the future.

We recommend installing the DSO CLI in an isolated environment using, e.g., uv or pipx.

uv tool install dso-core

This command installs the dso binary:

$ dso --version
dso, version 0.1.dev1+gc3f22fd

If you prefer to manage the Python environment yourself, you can use pip as usual:

pip install dso-core

Freezing the dso version within a project#

Attention

This feature is still experimental. In particular, we are still working on the ergonomics, as remembering to type uv run dso every time is not very user-friendly. Once this is worked out, it will very likely become the default for all dso projects.

See also dso#3.

To ensure consistent results between collaborators and that the porject can be reproduced in exactly the same way in the future, it is good practice to pin a specific version of dso within each project. Since each dso project is also a uv project with dependencies declared in pyproject.toml, this makes it easy freeze the dso version.

By using

uv run dso

instead of

dso

uv runs the specified version of dso and installes it automatically in the background, if necessary. Running this command for the first time will create a uv.lock file that contains the exact information about the project’s dependencies.

To update the version of dso within the project, you can use

uv add -U dso_core