Skip to content

Commit

Permalink
README: also add pipx installation instructions
Browse files Browse the repository at this point in the history
The `pipx` command takes away some of the tedium of managing per-package
Python virtual environments, but may not be available everywhere yet.

So make `pipx` the number two option, after installation from the Linux
distribution, but leave the other option of manually managing the `venv`
in as well.

Signed-off-by: Leonard Göhrs <[email protected]>
  • Loading branch information
hnez committed Apr 29, 2024
1 parent 1d33fc9 commit f200d4a
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,18 @@ Installation from your Linux Distribution
The easiest way to install the ``usbsdmux`` tool and stay somewhat up to date without having to deal with Python virtual environments.
May not be available for your distribution and may be lacking in features because distributions ship older software versions.

Installation from PyPi
Installation via pipx from PyPi
Another way to install the ``usbsdmux`` from a pre-packaged source.
Always installs the latest ``usbsdmux`` release, but needs to be kept up to date manually.
Also needs a re-install when your systems Python version is updated.

This installation method uses `pipx` to automate the Python virtual
environment management.

Installation in a venv from PyPi
This method is very similar to the `pipx` method,
but manages the virtual environment manually instead of letting `pipx` manage it.

Installation from Source
The way to go if you can not wait to test out new features.

Expand All @@ -48,8 +55,26 @@ So you can simply ``apt install usbsdmux`` and skip all installation steps below

Packages also exist for `some other distributions <https://repology.org/project/usbsdmux/versions>`_.

Installation from PyPi Packages
```````````````````````````````
Installation via pipx from PyPi Packages
````````````````````````````````````````

Install ``pipx`` via your Linux distributions package manager,
e.g.:

.. code-block:: bash
$ sudo apt install pipx # For Debian based distributions
$ sudo pacman -S python-pipx # For Arch Linux based distributions
And follow the ``pipx`` manual on how to add ``pipx``-installed software to
your ``PATH``, e.g. by using ``pipx ensurepath``.

And finally install the ``usbsdmux`` package using ``pipx``:

$ pipx install usbsdmux

Installation in a venv from PyPi Packages
`````````````````````````````````````````

Create and activate a Python virtual environment for the ``usbsdmux`` package:

Expand Down

0 comments on commit f200d4a

Please sign in to comment.