Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-03 06:22:48 +01:00
Code Issues Projects Releases Wiki Activity

docs: update the pip install instructions

Browse source 
Using ``sudo`` to install Python packages using pip is not a good
practice security-wise. This commit will suggest an alternative way
using ``--user`` to make sure the package is installed locally.
This commit is contained in:
Pierre 2018-10-23 15:20:25 +08:00 committed by Pierre Equoy
parent 1828114528
commit 8f6c7cb8cd
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/guides/main.rst
View file

@ -58,8 +58,8 @@ Beets works on `Python 2.7`_ and Python 3.4 or later.
.. _Ubuntu details: https://launchpad.net/ubuntu/+source/beets
.. _beets is in [community]: https://www.archlinux.org/packages/community/any/beets/
If you have `pip`_, just say ``pip install beets`` (you might need ``sudo`` in
front of that).
If you have `pip`_, just say ``pip install beets`` (or ``pip install --user
beets`` if you run into permissions problems).
To install without pip, download beets from `its PyPI page`_ and run ``python
setup.py install`` in the directory therein.
@ -79,12 +79,12 @@ Installing on macOS 10.11 and Higher
Starting with version 10.11 (El Capitan), macOS has a new security feature
called `System Integrity Protection`_ (SIP) that prevents you from modifying
some parts of the system. This means that some ``pip`` commands may fail with
a permissions error, even when you use ``sudo``. (You probably *won't* run
into this if you've installed Python yourself with `Homebrew`_ or otherwise.)
a permissions error. (You probably *won't* run into this if you've installed
Python yourself with `Homebrew`_ or otherwise.)
If this happens, you can install beets for the current user only (sans
``sudo``) by typing ``pip install --user beets``. If you do that, you might want
to add ``~/Library/Python/3.6/bin`` to your ``$PATH``.
If this happens, you can install beets for the current user only by typing
``pip install --user beets``. If you do that, you might want to add
``~/Library/Python/3.6/bin`` to your ``$PATH``.
.. _System Integrity Protection: https://support.apple.com/en-us/HT204899
.. _Homebrew: http://brew.sh