From 919a284364d916742d99a1b16b6f6c0587377912 Mon Sep 17 00:00:00 2001 From: Justaus3r <72691864+Justaus3r@users.noreply.github.com> Date: Wed, 21 Sep 2022 22:19:51 +0500 Subject: [PATCH] docs: pipx installation caveat --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9818d51..b5625a8 100644 --- a/README.rst +++ b/README.rst @@ -74,11 +74,12 @@ The simplest way to install ceg with battery included is by using pip: From PYPI using pipx ~~~~~~~~~~~~~~~~~~~~ -You can also use `pipx`_ if you plan to only use ceg as a command line tool.pipx ensures dependency isolation and is made specifically for cli tools. +You can also use `pipx`_ if you plan to only use ceg as a command line tool.pipx ensures dependency isolation and is made specifically for cli tools. but please be aware that you will not be able to use ceg as a library if installed from pipx since its installed in a virtenv. :: python3 -m pipx install --system-site-packages ceg + Manually ~~~~~~~~ You can also install ceg manually. for that, you need to have poetry_ installed and be on a system with a minimal python version being ``3.7`` (one thing to keep in mind is that i am using python 3.10 so you will need to change python version in pyproject.yaml to your version and build it with that).after installing poetry, you can just do ``poetry build`` and pip install from ``dist/ceg*.whl`` or whatever you prefer. however please be mindful that installing poetry from pip is `not recommended`_.