+.. Copyright (C) The Arvados Authors. All rights reserved.
+..
+.. SPDX-License-Identifier: AGPL-3.0
+
========================
Arvados Keep FUSE Driver
========================
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``::
+
+ python3 -m venv ~/arvclients
+ ~/arvclients/bin/pip install arvados_fuse
+
+Command line tools will be installed under ``~/arvclients/bin``. You can
+test one by running::
+
+ ~/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::
-1. Run ``pip install --user arvados_fuse``.
+ export PATH="$PATH:$HOME/arvclients/bin"
-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.
+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::
-3. Reload your shell configuration. For example, bash users could run
- ``source ~/.bashrc``.
+ arv-mount --version
Installing on Debian systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Add this Arvados repository to your sources list::
- deb http://apt.arvados.org/ wheezy main
+ deb http://apt.arvados.org/buster buster main
2. Update your package list.
-3. Install the ``python-arvados-fuse`` package.
+3. Install the ``python3-arvados-fuse`` package.
Configuration
-------------
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
-<https://arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
+<https://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
describes how to set up a development environment and run tests.