15924: Update github links to arvados org.
[arvados.git] / doc / sdk / python / arvados-fuse.html.textile.liquid
1 ---
2 layout: default
3 navsection: sdk
4 navmenu: Python
5 title: Arvados FUSE driver
6 ...
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 The Arvados FUSE driver is a Python utility that allows you to see the Keep service as a normal filesystem, so that data can be accessed using standard tools. This driver requires the Python SDK installed in order to access Arvados services.
14
15 h3. Installation
16
17 If you are logged in to an Arvados VM, the @arv-mount@ utility should already be installed.
18
19 To use the FUSE driver elsewhere, you can install from a distribution package, PyPI, or source.
20
21 {% include 'notebox_begin' %}
22 The Arvados FUSE driver requires Python 2.7
23 {% include 'notebox_end' %}
24
25 h4. Option 1: Install from distribution packages
26
27 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
28
29 {% assign rh_version = "6" %}
30 {% include 'note_python_sc' %}
31
32 On Red Hat-based systems:
33
34 <notextile>
35 <pre><code>~$ <span class="userinput">echo 'exclude=python2-llfuse' | sudo tee -a /etc/yum.conf</span>
36 ~$ <span class="userinput">sudo yum install python-arvados-fuse</code>
37 </code></pre>
38 </notextile>
39
40 On Debian-based systems:
41
42 <notextile>
43 <pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-fuse</code>
44 </code></pre>
45 </notextile>
46
47 h4. Option 2: Install with pip
48
49 Run @pip install arvados_fuse@ in an appropriate installation environment, such as a virtualenv.
50
51 h4. Option 3: Install from source
52
53 Install the @python-setuptools@ package from your distribution.  Then run the following:
54
55 <notextile>
56 <pre><code>~$ <span class="userinput">git clone https://github.com/arvados/arvados.git</span>
57 ~$ <span class="userinput">cd arvados/services/fuse</span>
58 ~/arvados/services/fuse$ <span class="userinput">python setup.py install</span>
59 </code></pre>
60 </notextile>
61
62 h3. Usage
63
64 Please refer to the "Accessing Keep from GNU/Linux":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-gnu-linux.html tutorial for more information.