Metadata-Version: 2.1
Name: arvados-fuse
Version: 2.6.0rc6
Summary: Arvados FUSE driver
Home-page: https://arvados.org
Author: Arvados
Author-email: info@arvados.org
License: GNU Affero General Public License, version 3.0
Download-URL: https://github.com/arvados/arvados.git
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Requires-Dist: arvados-python-client (==2.6.0rc6)
Requires-Dist: ciso8601 (>=2.0.0)
Requires-Dist: future
Requires-Dist: llfuse (>=1.3.6)
Requires-Dist: prometheus-client
Requires-Dist: python-daemon
Requires-Dist: setuptools
Requires-Dist: pytz ; python_version<"3"

.. Copyright (C) The Arvados Authors. All rights reserved.
..
.. SPDX-License-Identifier: AGPL-3.0

========================
Arvados Keep FUSE Driver
========================

Overview
--------

This package provides a FUSE driver for Keep, the Arvados_ storage
system.  It allows you to read data from your collections as if they
were on the local filesystem.

.. _Arvados: https://arvados.org/

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.

1. Run ``pip install --user 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.

3. Reload your shell configuration.  For example, bash users could run
   ``source ~/.bashrc``.

Installing on Debian systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Add this Arvados repository to your sources list::

     deb http://apt.arvados.org/buster buster main

2. Update your package list.

3. Install the ``python3-arvados-fuse`` package.

Configuration
-------------

This driver needs two pieces of information to connect to
Arvados: the DNS name of the API server, and an API authorization
token.  You can set these in environment variables, or the file
``$HOME/.config/arvados/settings.conf``.  `The Arvados user
documentation
<http://doc.arvados.org/user/reference/api-tokens.html>`_ describes
how to find this information in the Arvados Workbench, and install it
on your system.

Testing and Development
-----------------------

Debian packages you need to build llfuse:

$ apt-get install python-dev pkg-config libfuse-dev libattr1-dev

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://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
describes how to set up a development environment and run tests.


