Installation

OS Support

Any Linux or Unix distribution that provides the dependencies below should work.

For Windows, the instructions below reportedly work in WSL.

Feel free to report any issues you find with your OS.

Dependencies

Python
mediainfo (CLI version)
ffmpeg (optional: screenshot creation)
ffprobe (optional: faster video duration detection)
oxipng (optional: shrink screenshots by ~40 %)

Installing Current Release

pipx is the recommended installation tool. It creates a separate virtual environment for each installed Python package that contains all the dependencies to avoid conflicts and to make it trivial to uninstall packges completely.

pipx (recommended)

Try installing pipx with your package manager, e.g.
```
$ sudo apt install pipx
```
If that fails, this command should install pipx in ~/.local:
```
$ pip install --user pipx
```
Make sure ~/.local/bin is in your PATH. If you don’t know how to do that, try this command:
```
$ python3 -m pipx ensurepath
```
Install upsies with pipx:
```
$ pipx install upsies
```
Uninstall upsies:
```
$ pipx uninstall upsies
```
Upgrade to the latest release:
```
$ pipx uninstall upsies && pipx install upsies
```
Note

You can also run pipx upgrade upsies, but you might run into issues if dependencies change between releases.

pip

Installing with pip is messy because it installs everything in the same environment and it doesn’t provide any way to remove dependencies.

Only do this if you don’t care or if installing with pipx is not possible for some reason.

$ # Install upsies
$ pip install --user upsies
$ # Update to the latest version
$ pip install --user --upgrade upsies
$ # Remove upsies (but not its dependencies)
$ pip uninstall upsies

Installing alpha version from Git Repository

If you want to install the current prerelease version without having to clone the repo, you can also do that with pipx.

You need pipx 0.15.0.0 or later.

$ # Initial installation
$ pipx install 'git+https://codeberg.org/plotski/upsies.git'
$ # Upgrade existing installation to latest commit
$ pipx install 'git+https://codeberg.org/plotski/upsies.git' --force

Installing Specific Version

You can install an older version if the installed release has a bug.

$ pipx install upsies==<version> --force

See https://pypi.org/project/upsies/#history for a list of versions.

Podman

There is a shell script that runs upsies in a Podman container base on Alpine Linux.

$ # Download script to your $PATH and make it executable.
$ wget https://codeberg.org/plotski/upsies/raw/branch/master/goodies/upsies-podman.sh \
       -O ~/.local/bin/upsies
$ chmod u+x ~/.local/bin/upsies
$ # Read and follow the CONFIGURATION section and adjust the script.
$ $EDITOR ~/.local/bin/upsies
$ # Build the Podman image.
$ upsies build
$ # Use the script as you would use upsies normally.
$ upsies submit --help
$ # Upgrade the container image when there is a newer upsies version.
$ upsies upgrade
$ # Delete the upsies image and the Alpine base image.
$ podman rmi upsies alpine