.. 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 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
<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": null,
"maintainer_email": null,
"keywords": null,
"author": "Arvados",
"author_email": "info@arvados.org",
"download_url": "https://files.pythonhosted.org/packages/0f/6b/adfdafb1f890ff7c63868b68e482f6be21de653acefa688bc103d460fb96/arvados-python-client-2.7.4.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 systems\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n1. Add this Arvados repository to your sources list::\n\n deb http://apt.arvados.org/ buster main\n\n2. Update your package list.\n\n3. Install the ``python3-arvados-python-client`` package.\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. You can set these in environment variables, or the file\n``$HOME/.config/arvados/settings.conf``. `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": "2.7.4",
"project_urls": {
"Download": "https://github.com/arvados/arvados.git",
"Homepage": "https://arvados.org"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b87efb2ede4c18c275c4de204fe8a9f2436c28abf27efc690f474e5ae1de2da",
"md5": "a1d74413af6437f6b3737ddadb913170",
"sha256": "263b78c80fdcb7e52df800bf6915a871dbf74c7160a9d182de66b3384fa84b47"
},
"downloads": -1,
"filename": "arvados_python_client-2.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1d74413af6437f6b3737ddadb913170",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 275877,
"upload_time": "2024-07-08T21:19:56",
"upload_time_iso_8601": "2024-07-08T21:19:56.601377Z",
"url": "https://files.pythonhosted.org/packages/2b/87/efb2ede4c18c275c4de204fe8a9f2436c28abf27efc690f474e5ae1de2da/arvados_python_client-2.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f6badfdafb1f890ff7c63868b68e482f6be21de653acefa688bc103d460fb96",
"md5": "dcd45b3c9d191b7221fed79b666a3178",
"sha256": "932398da39daba88041f1084d19019e7300cac462ef93f181f40aa85562ff275"
},
"downloads": -1,
"filename": "arvados-python-client-2.7.4.tar.gz",
"has_sig": false,
"md5_digest": "dcd45b3c9d191b7221fed79b666a3178",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 248801,
"upload_time": "2024-07-08T21:19:51",
"upload_time_iso_8601": "2024-07-08T21:19:51.290714Z",
"url": "https://files.pythonhosted.org/packages/0f/6b/adfdafb1f890ff7c63868b68e482f6be21de653acefa688bc103d460fb96/arvados-python-client-2.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 21:19:51",
"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
