From ec6a1d5b146a433d40ec752afc96ee5eb95b3cc3 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Thu, 27 Aug 2020 11:52:21 +0200 Subject: [PATCH 1/2] DOC: update "installation" section --- doc/installation.rst | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/doc/installation.rst b/doc/installation.rst index f4ee955..5b05a73 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,19 +1,27 @@ Installation ============ -On Windows, macOS, and Linux you can install a precompiled wheel with:: +On Windows, macOS and Linux you can install a precompiled "wheel" package with:: - python3 -m pip install rtmixer + python3 -m pip install rtmixer --user This will install ``rtmixer`` and its dependencies, including ``sounddevice``. +Depending on your Python installation, +you may have to use ``python`` instead of ``python3``. +If you want to install the module system-wide for all users +(assuming you have the necessary rights), +you should drop the ``--user`` flag. +If you are using a `virtual environment`_, +you should also drop the ``--user`` flag +(otherwise you'll get an error like +``ERROR: Can not perform a '--user' install. +User site-packages are not visible in this virtualenv.``). +If you have installed the module already, +you can use the ``--upgrade`` flag to get the newest release. + +.. _`virtual environment`: https://docs.python.org/3/tutorial/venv.html + .. note:: On Linux, to use ``sounddevice`` and ``rtmixer`` you will need to have PortAudio installed, e.g. via ``sudo apt install libportaudio2``. On other platforms, PortAudio comes bundled with ``sounddevice``. - -Developers can install in editable mode with some variant of:: - - git clone https://github.com/spatialaudio/python-rtmixer - cd python-rtmixer - git submodule update --init - python3 -m pip install -e . From f0036fdb6cff590b8d628f6cc264ccae89f49ad0 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Sat, 5 Sep 2020 18:34:11 +0200 Subject: [PATCH 2/2] DOC: Remove the --user flag from the instructions --- CONTRIBUTING.rst | 4 ++-- doc/installation.rst | 12 +----------- 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 77e4d4d..de9209b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,7 +15,7 @@ newest development version (a.k.a. "master") with Git:: git clone https://github.com/spatialaudio/python-rtmixer.git --recursive cd python-rtmixer - python3 -m pip install -e . --user + python3 -m pip install -e . ... where ``-e`` stands for ``--editable``. @@ -51,7 +51,7 @@ pages locally using Sphinx and check if they look OK. Initially, you might need to install a few packages that are needed to build the documentation:: - python3 -m pip install -r doc/requirements.txt --user + python3 -m pip install -r doc/requirements.txt To (re-)build the HTML files, use:: diff --git a/doc/installation.rst b/doc/installation.rst index 5b05a73..a773180 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -3,25 +3,15 @@ Installation On Windows, macOS and Linux you can install a precompiled "wheel" package with:: - python3 -m pip install rtmixer --user + python3 -m pip install rtmixer This will install ``rtmixer`` and its dependencies, including ``sounddevice``. Depending on your Python installation, you may have to use ``python`` instead of ``python3``. -If you want to install the module system-wide for all users -(assuming you have the necessary rights), -you should drop the ``--user`` flag. -If you are using a `virtual environment`_, -you should also drop the ``--user`` flag -(otherwise you'll get an error like -``ERROR: Can not perform a '--user' install. -User site-packages are not visible in this virtualenv.``). If you have installed the module already, you can use the ``--upgrade`` flag to get the newest release. -.. _`virtual environment`: https://docs.python.org/3/tutorial/venv.html - .. note:: On Linux, to use ``sounddevice`` and ``rtmixer`` you will need to have PortAudio installed, e.g. via ``sudo apt install libportaudio2``. On other platforms, PortAudio comes bundled with ``sounddevice``.