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

Uploaded Source

Built Distribution

arvados_python_client-2.7.3-py3-none-any.whl (275.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arvados-python-client-2.7.3.tar.gz
  • Upload date:
  • Size: 248.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.2

File hashes

Hashes for arvados-python-client-2.7.3.tar.gz
Algorithm Hash digest
SHA256 9ef9050ce680832bff76f8d283e3b445252f21ee927b2b63949271fe9b2a4bc2
MD5 09d236a2b956620a96820d2440c7de1d
BLAKE2b-256 2db6d9fa8e466ed62b0589e6e987ae127c7c987489055cd284d928dc7e6a3737

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arvados_python_client-2.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 52d59eeddd42e9b9192730c18375f8d0eea788289e406651b17f19ca4506f952
MD5 b7e65123b0fb9b39af45e1a221f54f6a
BLAKE2b-256 7745cbe13f5231fee65e5a577d5b299f657795e5fbd9fa8d3a19a6674a0f5014

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