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 master. The latest release is 4.1.0.
GitHub

Installation

Installation on Linux is recommended, but it is also known to work on Windows and macOS.

Linux

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

    apt install python3-full python3-pip python3-venv 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 https://github.com/peterkuma/ds-format/archive/refs/heads/master.zip
    mkdir -p ~/.local/share/man/man1
    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. This can be done with pipx ensurepath.

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

    pip3 install https://github.com/peterkuma/ds-format/archive/refs/heads/master.zip
    

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

    Alternatively, install into a Python virtual environment with:

    python3 -m venv venv
    . venv/bin/activate
    pip3 install https://github.com/peterkuma/ds-format/archive/refs/heads/master.zip
    

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

You should now be able to run the command ds and view the manual page with man ds.

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.

Windows

  1. Install Python. In the installer, tick Add python.exe to PATH.

  2. Open the Command Prompt from the Start menu. Install ds format with:

     pip install https://github.com/peterkuma/ds-format/archive/refs/heads/master.zip
    

You should now be able to run the command ds.

To uninstall:

pip uninstall ds-format

macOS

Important: On macOS the ds command should be used with the command line shell bash, not the default zsh, which is not compatible with the argument syntax.

Open the Terminal. Install ds format with:

python3 -m pip install https://github.com/peterkuma/ds-format/archive/refs/heads/master.zip

Make sure that /Users/<user>/Library/Python/<version>/bin is included in the PATH environment variable if not already, where <user> is your system user name and <version> is the Python version. This path should be printed by the above command. This can be done by adding this line to the file .zprofile in your home directory and restart the Terminal:

PATH="$PATH:/Users/<user>/Library/Python/<version>/bin"

You should now be able to run the command ds and view the manual page with man ds.

To uninstall:

python3 -m pip uninstall ds-format

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)