Skip to main content

Arvados client library

Project description

Overview

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.

Installation

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 http://apt.arvados.org/ buster main
  2. Update your package list.

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

Configuration

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

This version

2.7.2

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.2.tar.gz (245.1 kB view details)

Uploaded Source

Built Distribution

arvados_python_client-2.7.2-py3-none-any.whl (275.5 kB view details)

Uploaded Python 3

File details

Details for the file arvados-python-client-2.7.2.tar.gz.

File metadata

File hashes

Hashes for arvados-python-client-2.7.2.tar.gz
Algorithm Hash digest
SHA256 97b064ee9e1fa1340c1742758c9ca7e787585118f8ccf94704033bd9ba5c05ed
MD5 be7167ab64121380f41226ac285c5fe3
BLAKE2b-256 9a46b0a94a940d3c20fe017fd5ad2cd8b62d68fe4cf6ead6d6868f7eb5862b43

See more details on using hashes here.

File details

Details for the file arvados_python_client-2.7.2-py3-none-any.whl.

File metadata

File hashes

Hashes for arvados_python_client-2.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88b014d40907fe8797f5074690d65449033f38316d5c852fbc86421f322d5096
MD5 ea2b99644ef255532e01458481d2d5d4
BLAKE2b-256 a0b7529fb2a885b9b564d908ea2ec610c7e2468ece3912f2008fa13b5a6e53f3

See more details on using hashes here.

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