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 and Ubuntu systems

Arvados publishes packages for Debian 11 “bullseye,” Debian 12 “bookworm,” Ubuntu 20.04 “focal,” and Ubuntu 22.04 “jammy.” You can install the Python SDK package on any of these distributions by running the following commands:

sudo install -d /etc/apt/keyrings
sudo curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg
sudo tee /etc/apt/sources.list.d/arvados.sources >/dev/null <<EOF
Types: deb
URIs: https://apt.arvados.org/$(lsb_release -cs)
Suites: $(lsb_release -cs)
Components: main
Signed-by: /etc/apt/keyrings/arvados.asc
EOF
sudo apt update
sudo apt install python3-arvados-python-client

Installing on Red Hat, AlmaLinux, and Rocky Linux

Arvados publishes packages for RHEL 8 and distributions based on it. Note that these packages depend on, and will automatically enable, the Python 3.9 module. You can install the Python SDK package on any of these distributions by running the following commands:

sudo tee /etc/yum.repos.d/arvados.repo >/dev/null <<'EOF'
[arvados]
name=Arvados
baseurl=http://rpm.arvados.org/RHEL/$releasever/os/$basearch/
gpgcheck=1
gpgkey=http://rpm.arvados.org/RHEL/RPM-GPG-KEY-arvados
EOF
sudo dnf install python3-arvados-python-client

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

Uploaded Source

Built Distribution

arvados_python_client-3.1.2-py3-none-any.whl (299.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arvados-python-client-3.1.2.tar.gz
  • Upload date:
  • Size: 246.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for arvados-python-client-3.1.2.tar.gz
Algorithm Hash digest
SHA256 9538e70073e489043e2c2ebd2e01c96215a90ee12e07678960cc3ef2f731534a
MD5 ceaaff4b4fff4dc9149778ed46647e4d
BLAKE2b-256 8d887bbeec9872317fda7769a2dc55bea187d8483148f258f7e3916a126a96dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arvados_python_client-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8afca295a34a7153dcdbe0433f1433dd9bd58e24740c7e039a2b9a72538de3ed
MD5 e7d377b19a96eb249bf5579feee6373a
BLAKE2b-256 0abbb8b3f15742e529326fe1a0cea6142bf98b63204f4f1ecbcda6cc519c80a5

See more details on using hashes here.

Supported by

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