X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/418c57bce3aac1a22548e53e1018a1547d9efee4..0019db357afed7f52da38e9c398f3e39ce4eb162:/sdk/python/README.rst diff --git a/sdk/python/README.rst b/sdk/python/README.rst index a03d6afe6a..e40866c624 100644 --- a/sdk/python/README.rst +++ b/sdk/python/README.rst @@ -22,28 +22,40 @@ 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. +You can test the change by running:: + + arv-get --version Installing on Debian systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1. Add this Arvados repository to your sources list:: - deb http://apt.arvados.org/ stretch main + deb http://apt.arvados.org/ buster main 2. Update your package list. -3. Install the ``python-arvados-python-client`` package. +3. Install the ``python3-arvados-python-client`` package. Configuration ------------- @@ -63,5 +75,5 @@ Testing and Development This package is one part of the Arvados source package, and it has integration tests to check interoperability with other Arvados components. Our `hacking guide -`_ +`_ describes how to set up a development environment and run tests.