ds format

Documentation version: 2.0.1 3.0.0 3.1.0 3.2.0 3.3.3 3.4.0 3.5.2 3.6.1 3.7.0 4.0.1 4.1.0 (latest) master
You are viewing documentation for version 3.7.0. The latest release is 4.1.0.


Installation on Linux is recommended, but it is also known to work on Windows and macOS. On macOS the command line interface should be used with bash, not the default zsh, which is not compatible with the syntax.


Default Python distribution on Linux

  1. Install the required system packages. On Debian-derived distributions (Ubuntu, Devuan, …):

    apt install python3-full python3-pip pipx

    On Fedora:

    sudo yum install python3 python3-pip pipx
  2. Install ds format. If you indend to use the command-line interface, you can install ds format with pipx:

    pipx install ds-format==3.7.0
    ln -s ~/.local/pipx/venvs/ds-format/share/man/man1/ds*.1 ~/.local/share/man/man1/

    You might have to add $HOME/.local/bin to the PATH environment variable if not present already in order to access the ds command.

    If you indend to use the Python interface, you can install in the home directory with pip3:

    pip3 install ds-format==3.7.0

    Replace pip3 with pip if pip3 is not available. Add --break-system-packages if your distribution does not allow installing into home directory but you want to anyway.

    Alternatively, install into a Python virtual environment with:

    python3 -m venv venv
    . venv/bin/activate
    pip3 install ds-format==3.7.0

    You can then use the ds format Python interface from within the virtual environment. Deactivate the environment with deactivate.

Anaconda on Linux, Windows or macOS

  1. Install Anaconda.

  2. Install ds format in the terminal (Linux and macOS) or Anaconda Prompt (Windows):

    pip install ds-format==3.7.0


To uninstall if installed with pipx:

pipx uninstall ds-format
rm ~/.local/pipx/venvs/ds-format/share/man/man1/ds*.1

To uninstall if installed with pip3 or pip:

pip3 uninstall ds-format

Replace pip3 with pip if pip3 is not available.

Release notes

4.1.0 (2024-02-16)

4.0.1 (2023-09-06)

4.0.0 (2023-09-06)

3.7.0 (2023-04-24)

3.6.1 (2023-04-21)

3.6.0 (2023-04-01)

3.5.2 (2023-03-06)

3.5.1 (2022-11-30)

3.5.0 (2022-11-26)

3.4.0 (2022-11-22)

3.3.3 (2022-11-13)

3.3.2 (2022-11-13)

3.3.1 (2022-11-10)

3.3.0 (2022-10-16)

3.2.0 (2022-10-09)

3.1.0 (2022-10-05)

3.0.0 (2022-09-30)

2.0.1 (2022-09-26)

2.0.0 (2022-07-31)

1.1.2 (2022-01-01)

1.1.1 (2021-12-11)

1.1.0 (2021-03-31)

1.0.1 (2020-08-12)

1.0.0 (2020-04-28)