3252: Add Python package documentation.

This documentation will be displayed nicely on both GitHub and PyPI.

diff --git a/sdk/python/README.rst b/sdk/python/README.rst
new file mode 100644 (file)
index 0000000..10e01a4
--- /dev/null
+++ b/sdk/python/README.rst
@@ -0,0 +1,63 @@
+=====================
+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 won't be able to use it.
+
+1. Run ``pip install --user arvados-python-client``.
+
+2. In your shell configuration, make sure you add ``$HOME/.local/bin``
+   to your PATH environment variable.  For example, you could add the
+   command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
+
+3. Reload your shell configuration.  For example, bash users could run
+   ``source ~/.bashrc``.
+
+Installing on Debian systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Add this Arvados repository to your sources list::
+
+     deb http://apt.arvados.org/ wheezy main
+
+2. Update your package list.
+
+3. Install the ``python-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://arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
+describes how to set up a development environment and run tests.

diff --git a/sdk/python/setup.py b/sdk/python/setup.py
index ae6ce54745ced37a34336e146898107941a0d758..2c51e8f1d0f6a5d56c06c73016ccf7ef1418f770 100644 (file)
--- a/sdk/python/setup.py
+++ b/sdk/python/setup.py
@@ -1,8 +1,15 @@
+#!/usr/bin/env python
+
+import os
+
 from setuptools import setup, find_packages
 
+README = os.path.join(os.path.dirname(__file__), 'README.rst')
+
 setup(name='arvados-python-client',
       version='0.1',
       description='Arvados client library',
+      long_description=open(README).read(),
       author='Arvados',
       author_email='info@arvados.org',
       url="https://arvados.org",

diff --git a/services/fuse/README.rst b/services/fuse/README.rst
new file mode 100644 (file)
index 0000000..d9a9a07
--- /dev/null
+++ b/services/fuse/README.rst
@@ -0,0 +1,62 @@
+========================
+Arvados Keep FUSE Driver
+========================
+
+Overview
+--------
+
+This package provides a FUSE driver for Keep, the Arvados_ storage
+system.  It allows you to read data from your collections as if they
+were on the local filesystem.
+
+.. _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 won't be able to use it.
+
+1. Run ``pip install --user arvados_fuse``.
+
+2. In your shell configuration, make sure you add ``$HOME/.local/bin``
+   to your PATH environment variable.  For example, you could add the
+   command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
+
+3. Reload your shell configuration.  For example, bash users could run
+   ``source ~/.bashrc``.
+
+Installing on Debian systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Add this Arvados repository to your sources list::
+
+     deb http://apt.arvados.org/ wheezy main
+
+2. Update your package list.
+
+3. Install the ``python-arvados-fuse`` package.
+
+Configuration
+-------------
+
+This driver 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://arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
+describes how to set up a development environment and run tests.

diff --git a/services/fuse/readme.llfuse b/services/fuse/readme.llfuse
deleted file mode 100644 (file)
index f88a59b..0000000
--- a/services/fuse/readme.llfuse
+++ /dev/null
@@ -1 +0,0 @@
-apt-get install python-dev libattr1-dev libfuse-dev pkg-config

diff --git a/services/fuse/setup.py b/services/fuse/setup.py
index 8ee920d53d3150988d2c77e7c6598253523ea432..d9fe797b8ee06df097381f8bd896a03e8db46589 100644 (file)
--- a/services/fuse/setup.py
+++ b/services/fuse/setup.py
@@ -1,10 +1,15 @@
 #!/usr/bin/env python
 
-from setuptools import setup
+import os
+
+from setuptools import setup, find_packages
+
+README = os.path.join(os.path.dirname(__file__), 'README.rst')
 
 setup(name='arvados_fuse',
       version='0.1',
       description='Arvados FUSE driver',
+      long_description=open(README).read(),
       author='Arvados',
       author_email='info@arvados.org',
       url="https://arvados.org",