Skip to content

Commit

Permalink
docs: pipx installation caveat
Browse files Browse the repository at this point in the history
  • Loading branch information
Justaus3r authored Sep 21, 2022
1 parent a1b42ae commit 919a284
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`_.
Expand Down

0 comments on commit 919a284

Please sign in to comment.