Skip to main content

Arvados client library

Project description


This package provides the arvados module, an API client for Arvados. It also includes higher-level functions to help you write Crunch scripts, and command-line tools to store and retrieve data in the Keep storage server.


Installing under your user account

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-python-client

Command line tools will be installed under ~/arvclients/bin. You can test one by running:

~/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 buster main
  2. Update your package list.

  3. Install the python3-arvados-python-client package.


This client software 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 describes how to find this information in the Arvados Workbench, and install it on your system.

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.

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arvados-python-client-2.7.0.tar.gz (233.2 kB view hashes)

Uploaded source

Built Distribution

arvados_python_client-2.7.0-py3-none-any.whl (262.6 kB view hashes)

Uploaded 3 7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page