Fix 2.4.2 upgrade notes formatting refs #19330
[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 h2. Installation
16
17 If you are logged in to a managed 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, or PyPI.
20
21 h2. Option 1: Install from distribution packages
22
23 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/packages.html
24
25 {% assign arvados_component = 'python-arvados-fuse' %}
26
27 {% include 'install_packages' %}
28
29 h2. Option 2: Install with pip
30
31 Run @pip install arvados_fuse@ in an appropriate installation environment, such as a virtualenv.
32
33 Note:
34
35 The SDK uses @pycurl@ which depends on the @libcurl@ C library.  To build the module you may have to first install additional packages.  On Debian 10 this is:
36
37 <pre>
38 $ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-dev python3-llfuse
39 </pre>
40
41 h3. Usage
42
43 Please refer to the "Accessing Keep from GNU/Linux":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-gnu-linux.html tutorial for more information.