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

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for arvados-python-client-2.7.0.tar.gz
Algorithm Hash digest
SHA256 da948a17fcc8146175f17b37e14dc7ab12dfc96bb8b5e481e16568ea78918723
MD5 8d2c520eb96c09a8239238d106a9b459
BLAKE2b-256 7e61e5fb238f2b66d4993b936c171f16d247c3e82a9437537db1c90f98e6490f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arvados_python_client-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0aa6ce1a5d0226e27da938abecfd0f1183e4c112938d4863c6396e32aa2dc340
MD5 b90f8ba6b2cdc8d805aac10fccadbf24
BLAKE2b-256 746790141ef5d385c2efa90a973d7d38ef7d5bdf4cc0688d087b3641ed618083

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