[arvados] created: 2.6.0-359-g863c2ec50
git repository hosting
git at public.arvados.org
Fri Jul 7 19:46:05 UTC 2023
at 863c2ec507f778087942fa928bbc414ad75e2afc (commit)
commit 863c2ec507f778087942fa928bbc414ad75e2afc
Author: Brett Smith <brett.smith at curii.com>
Date: Fri Jul 7 15:44:03 2023 -0400
20543: Recommend users install Python packages in a virtualenv
`pip install --user` doesn't work on distributions that have adopted
PEP 668, including Debian 12+ and Ubuntu 23.04+.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/sdk/python/README.rst b/sdk/python/README.rst
index 5e9bf64c4..4aa535523 100644
--- a/sdk/python/README.rst
+++ b/sdk/python/README.rst
@@ -22,17 +22,31 @@ Installation
Installing under your user account
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This method lets you install the package without root access.
-However, other users on the same system won't be able to use it.
+This method lets you install the package without root access. However,
+other users on the same system will need to reconfigure their shell in order
+to be able to use it. Run the following to install the package in an
+environment at ``~/arvclients``::
-1. Run ``pip install --user arvados-python-client``.
+ python3 -m venv ~/arvclients
+ ~/arvclients/bin/pip install arvados-python-client
-2. In your shell configuration, make sure you add ``$HOME/.local/bin``
- to your PATH environment variable. For example, you could add the
- command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
+Command line tools will be installed under ``~/arvclients/bin``. You can
+test one by running::
-3. Reload your shell configuration. For example, bash users could run
- ``source ~/.bashrc``.
+ ~/arvclients/bin/arv-get --version
+
+You can run these tools by specifying the full path every time, or you can
+add the directory to your shell's search path by running::
+
+ export PATH="$PATH:$HOME/arvclients/bin"
+
+You can make this search path change permanent by adding this command to
+your shell's configuration, for example ``~/.bashrc`` if you're using bash.
+
+Assuming they have permission to read inside your home directory, other
+users on the same system can use this installation by making a similar
+change to their shell's ``$PATH``. When they do, they will need to replace
+``$HOME`` with the static path to your own home directory.
Installing on Debian systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/services/fuse/README.rst b/services/fuse/README.rst
index e0d5046ae..771222d34 100644
--- a/services/fuse/README.rst
+++ b/services/fuse/README.rst
@@ -21,17 +21,31 @@ Installation
Installing under your user account
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This method lets you install the package without root access.
-However, other users on the same system won't be able to use it.
+This method lets you install the package without root access. However,
+other users on the same system will need to reconfigure their shell in order
+to be able to use it. Run the following to install the package in an
+environment at ``~/arvclients``::
-1. Run ``pip install --user arvados_fuse``.
+ python3 -m venv ~/arvclients
+ ~/arvclients/bin/pip install arvados_fuse
-2. In your shell configuration, make sure you add ``$HOME/.local/bin``
- to your PATH environment variable. For example, you could add the
- command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
+Command line tools will be installed under ``~/arvclients/bin``. You can
+test one by running::
-3. Reload your shell configuration. For example, bash users could run
- ``source ~/.bashrc``.
+ ~/arvclients/bin/arv-mount --version
+
+You can run these tools by specifying the full path every time, or you can
+add the directory to your shell's search path by running::
+
+ export PATH="$PATH:$HOME/arvclients/bin"
+
+You can make this search path change permanent by adding this command to
+your shell's configuration, for example ``~/.bashrc`` if you're using bash.
+
+Assuming they have permission to read inside your home directory, other
+users on the same system can use this installation by making a similar
+change to their shell's ``$PATH``. When they do, they will need to replace
+``$HOME`` with the static path to your own home directory.
Installing on Debian systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list