.. Copyright (C) The Arvados Authors. All rights reserved.
..
.. SPDX-License-Identifier: Apache-2.0
=====================
Arvados Python Client
=====================
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.
.. _Arvados: https://arvados.org/
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
<http://doc.arvados.org/user/reference/api-tokens.html>`_ 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
<https://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
describes how to set up a development environment and run tests.
Raw data
{
"_id": null,
"home_page": "https://arvados.org",
"name": "arvados-python-client",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Arvados",
"author_email": "info@arvados.org",
"download_url": "https://files.pythonhosted.org/packages/3b/b1/2bcbadeafa4227cc5345d6cf9d3aa424bc16fe09a93df45d2de8df4e5e0f/arvados-python-client-3.0.0.tar.gz",
"platform": null,
"description": ".. Copyright (C) The Arvados Authors. All rights reserved.\n..\n.. SPDX-License-Identifier: Apache-2.0\n\n=====================\nArvados Python Client\n=====================\n\nOverview\n--------\n\nThis package provides the ``arvados`` module, an API client for\nArvados_. It also includes higher-level functions to help you write\nCrunch scripts, and command-line tools to store and retrieve data in\nthe Keep storage server.\n\n.. _Arvados: https://arvados.org/\n\nInstallation\n------------\n\nInstalling under your user account\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis method lets you install the package without root access. However,\nother users on the same system will need to reconfigure their shell in order\nto be able to use it. Run the following to install the package in an\nenvironment at ``~/arvclients``::\n\n python3 -m venv ~/arvclients\n ~/arvclients/bin/pip install arvados-python-client\n\nCommand line tools will be installed under ``~/arvclients/bin``. You can\ntest one by running::\n\n ~/arvclients/bin/arv-get --version\n\nYou can run these tools by specifying the full path every time, or you can\nadd the directory to your shell's search path by running::\n\n export PATH=\"$PATH:$HOME/arvclients/bin\"\n\nYou can make this search path change permanent by adding this command to\nyour shell's configuration, for example ``~/.bashrc`` if you're using bash.\nYou can test the change by running::\n\n arv-get --version\n\nInstalling on Debian and Ubuntu systems\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nArvados 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::\n\n sudo install -d /etc/apt/keyrings\n sudo curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg\n sudo tee /etc/apt/sources.list.d/arvados.sources >/dev/null <<EOF\n Types: deb\n URIs: https://apt.arvados.org/$(lsb_release -cs)\n Suites: $(lsb_release -cs)\n Components: main\n Signed-by: /etc/apt/keyrings/arvados.asc\n EOF\n sudo apt update\n sudo apt install python3-arvados-python-client\n\nInstalling on Red Hat, AlmaLinux, and Rocky Linux\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nArvados 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::\n\n sudo tee /etc/yum.repos.d/arvados.repo >/dev/null <<'EOF'\n [arvados]\n name=Arvados\n baseurl=http://rpm.arvados.org/RHEL/$releasever/os/$basearch/\n gpgcheck=1\n gpgkey=http://rpm.arvados.org/RHEL/RPM-GPG-KEY-arvados\n EOF\n sudo dnf install python3-arvados-python-client\n\nConfiguration\n-------------\n\nThis client software needs two pieces of information to connect to\nArvados: the DNS name of the API server, and an API authorization\ntoken. `The Arvados user\ndocumentation\n<http://doc.arvados.org/user/reference/api-tokens.html>`_ describes\nhow to find this information in the Arvados Workbench, and install it\non your system.\n\nTesting and Development\n-----------------------\n\nThis package is one part of the Arvados source package, and it has\nintegration tests to check interoperability with other Arvados\ncomponents. Our `hacking guide\n<https://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_\ndescribes how to set up a development environment and run tests.",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Arvados client library",
"version": "3.0.0",
"project_urls": {
"Download": "https://github.com/arvados/arvados.git",
"Homepage": "https://arvados.org"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2fdf152fca7961eebdf7dcfb96cd97655a30980c52be8de05003552a91d905f0",
"md5": "6870601bad209ac7e11ccaeafb069502",
"sha256": "71bb92574bf183d28dafde679aa2454c6ecf170c371437a63aba1e623a7aaa0e"
},
"downloads": -1,
"filename": "arvados_python_client-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6870601bad209ac7e11ccaeafb069502",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 296011,
"upload_time": "2024-11-13T22:31:57",
"upload_time_iso_8601": "2024-11-13T22:31:57.094283Z",
"url": "https://files.pythonhosted.org/packages/2f/df/152fca7961eebdf7dcfb96cd97655a30980c52be8de05003552a91d905f0/arvados_python_client-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bb12bcbadeafa4227cc5345d6cf9d3aa424bc16fe09a93df45d2de8df4e5e0f",
"md5": "0baa434ddeb1ea2b69c74984c1c3ffba",
"sha256": "7f980029b27a27f0f348f610784757ca6ff419aee6eb903b046c37b719e1b820"
},
"downloads": -1,
"filename": "arvados-python-client-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0baa434ddeb1ea2b69c74984c1c3ffba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 243030,
"upload_time": "2024-11-13T22:31:54",
"upload_time_iso_8601": "2024-11-13T22:31:54.491585Z",
"url": "https://files.pythonhosted.org/packages/3b/b1/2bcbadeafa4227cc5345d6cf9d3aa424bc16fe09a93df45d2de8df4e5e0f/arvados-python-client-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 22:31:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arvados",
"github_project": "arvados",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "arvados-python-client"
}
JSON
