Installation

System Requirements

Ethos requires Python 3.9+ and VLC player installed in the system. It is multi-platform and the goal is to make it work equally well on Linux, macOS, and Windows.

Installation

If you are viewing documentation for the development branch, you may wish to install a preview or development version of Ethos. See the advanced installation instructions to use a preview or alternate version of Ethos.

with pipx (Recomended)

pipx is used to install Python CLI applications globally while still isolating them in virtual environments. pipx will manage upgrades and uninstalls when used to install Ethos.

1

Install pipx

If pipx is not already installed, you can follow any of the options in the official pipx installation instructions. Any non-ancient version pipx will do.

2

Install Ethos

pipx install ethos-cli

3

Verify the Installation

After installation, check if Ethos is installed correctly by running:

ethos-cli --version

If Ethos is installed properly, this command should output the installed version.

4

Install Ethos (advanced)

You can skip this step if you want the latest version and already installed Ethos as described in the previous step. This step details the advanced usage of this installation method. For example, installing Ethos from source, having multiple versions installed simultaneously, etc.

pipx can install different versions of Ethos, using the same syntax as pip:

pipx install ethos-cli==0.1.2

pipx can also install versions of Ethos in parallel, which allows for easy testing of alternate or prerelease versions. Each version is given a unique, user-specified suffix, which will be used to create a unique binary name:

pipx install --suffix=@1.8.4 ethos-cli==1.8.4
ethos-cli@1.8.4 --version

pipx install --suffix=@preview --pip-args=--pre ethos-cli
ethos-cli@preview --version

Finally, pipx can install any valid pip requirement spec, which allows for installations of the development version from git, or even for local testing of pull requests:

pipx install --suffix @main git+https://github.com/Itz-Agasta/ethos.git@main
pipx install --suffix @pr1234 git+https://github.com/Itz-Agasta/ethos.git@refs/pull/1234/head

5

Update Ethos

pipx upgrade ethos-cli

6

Uninstall Ethos

pipx uninstall ethos-cli

with pip

It is generally recommended to use pipx or a virtual environment. pipx is particularly useful for CLI applications like Ethos because it installs them in a dedicated environment while still making them accessible system-wide while avoiding PATH errors.

If you prefer not to use pipx, you can also install Ethos inside a virtual environment using venv, or docker which provides similar isolation benefits.