diff --git a/README.md b/README.md index 4fbaefb..d7664a9 100644 --- a/README.md +++ b/README.md @@ -46,13 +46,23 @@ Feel free to contribute improvements, as well as support for non-apt based syste ## Installation +### Global pip installation Run `pip3 install pkg-exporter`. +### Install from source Clone the repository and run `poetry install` from the main directory. You can also use other standard installation methods for python packages, like directly installing from this git repository. The pyinstaller-based binary is not provided any more. +### pipx +If a global pip installation is not possible (e.g. from debian 12 onwards), you can use [pipx](https://pypa.github.io/pipx), either for install, and/or for running pkg-exporter ad hoc: +``` +pipx run --system-site-packages pkg-exporter +``` + +`--system-site-packages` is necessary to provide access to the system python3-apt lib. + ### apt-based systems Currently, only apt-based systems are supported. `python3-apt` needs to be installed on the system. @@ -83,4 +93,4 @@ Example alerting rules will be provided in the future. ## Roadmap - Support for other pkg managers -- Deployment as dpkg-Packet \ No newline at end of file +- Deployment as dpkg-Packet