sdk/python/README.rst

   1 =====================
   2 Arvados Python Client
   3 =====================
   4
   5 Overview
   6 --------
   7
   8 This package provides the ``arvados`` module, an API client for
   9 Arvados_.  It also includes higher-level functions to help you write
  10 Crunch scripts, and command-line tools to store and retrieve data in
  11 the Keep storage server.
  12
  13 .. _Arvados: https://arvados.org/
  14
  15 Installation
  16 ------------
  17
  18 Installing under your user account
  19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  20
  21 This method lets you install the package without root access.
  22 However, other users on the same system won't be able to use it.
  23
  24 1. Run ``pip install --user arvados-python-client``.
  25
  26 2. In your shell configuration, make sure you add ``$HOME/.local/bin``
  27    to your PATH environment variable.  For example, you could add the
  28    command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
  29
  30 3. Reload your shell configuration.  For example, bash users could run
  31    ``source ~/.bashrc``.
  32
  33 Installing on Debian systems
  34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35
  36 1. Add this Arvados repository to your sources list::
  37
  38      deb http://apt.arvados.org/ wheezy main
  39
  40 2. Update your package list.
  41
  42 3. Install the ``python-arvados-python-client`` package.
  43
  44 Configuration
  45 -------------
  46
  47 This client software needs two pieces of information to connect to
  48 Arvados: the DNS name of the API server, and an API authorization
  49 token.  You can set these in environment variables, or the file
  50 ``$HOME/.config/arvados/settings.conf``.  `The Arvados user
  51 documentation
  52 <http://doc.arvados.org/user/reference/api-tokens.html>`_ describes
  53 how to find this information in the Arvados Workbench, and install it
  54 on your system.
  55
  56 Testing and Development
  57 -----------------------
  58
  59 This package is one part of the Arvados source package, and it has
  60 integration tests to check interoperability with other Arvados
  61 components.  Our `hacking guide
  62 <https://arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
  63 describes how to set up a development environment and run tests.