summaryrefslogtreecommitdiff
path: root/INSTALL.rst
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2020-12-17 10:10:35 +0100
committerGiampaolo Rodola <g.rodola@gmail.com>2020-12-17 10:10:35 +0100
commitef3946da95beee5bcbb298dd103341c90e63892f (patch)
treeb82b39fb43b29f78084e284a09e43b56f65ee4a2 /INSTALL.rst
parent31304fecf3b95bd4f27380c3066a8f95b515a00a (diff)
downloadpsutil-ef3946da95beee5bcbb298dd103341c90e63892f.tar.gz
update doc
Signed-off-by: Giampaolo Rodola <g.rodola@gmail.com>
Diffstat (limited to 'INSTALL.rst')
-rw-r--r--INSTALL.rst33
1 files changed, 16 insertions, 17 deletions
diff --git a/INSTALL.rst b/INSTALL.rst
index 9516a183..88cef33f 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -9,8 +9,9 @@ required to build the sources.
Pre-compiled cPython wheels are provided on each release though, so on
**Linux**, **Windows** and **macOS** all you have to do is::
- pip3 install psutil
+ pip3 install --user psutil
+This (``--user``) will install psutil as a limited user (not system-wide).
If wheels are not available for your platform or architecture, or you whish to
install psutil from sources, keep reading.
@@ -20,12 +21,12 @@ Linux (install from sources)
Ubuntu / Debian::
sudo apt-get install gcc python3-dev
- pip3 install --user psutil --no-binary :all:
+ pip3 install --user --no-binary :all: psutil
RedHat / CentOS::
sudo yum install gcc python3-devel
- pip3 install --user psutil --no-binary :all:
+ pip3 install --user --no-binary :all: psutil
Windows (install from sources)
------------------------------
@@ -36,7 +37,7 @@ Here's a couple of guides describing how to do it: `link <https://blog.ionelmc.r
and `link <https://cpython-core-tutorial.readthedocs.io/en/latest/build_cpython_windows.html>`__.
Once VS is installed do::
- pip3 install --user psutil --no-binary :all:
+ pip3 install --user --no-binary :all: psutil
FreeBSD
-------
@@ -77,15 +78,14 @@ Install::
pkg install gcc
python3 -m pip install psutil
-
Troubleshooting
===============
Install pip
-----------
-**Pip** is shipped by default with Python 2.7.9+ and 3.4+.
-If you don't have it you can install with wget::
+Pip is shipped by default with Python 2.7.9+ and 3.4+.
+If you don't have pip you can install with wget::
wget https://bootstrap.pypa.io/get-pip.py -O - | python3
@@ -98,19 +98,18 @@ cmd.exe and install it with::
C:\Python27\python.exe get-pip.py
-Permission errors (UNIX)
-------------------------
-
-If you bump into permission errors you have two options.
+"pip not found"
+---------------
-* Install psutil for your user only (non system-wide)::
+Sometimes pip is installed but it's not available in your ``PATH``
+(``pip command not found`` or similar). Try this::
- pip3 install --user psutil
-
-* Install it as root user (system-wide):
+ python3 -m pip install psutil
- pip3 install --user psutil
+Permission errors (UNIX)
+------------------------
-* Prepend ``sudo`` (system-wide)::
+If you want to install psutil system-wide and you bump into permission errors
+either run as root or prepend ``sudo``::
sudo pip3 install psutil