/build/
/dist/
+/*.egg
/*.egg-info
/tmp
--- /dev/null
+=====================
+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.
+++ /dev/null
-google-api-python-client>=1.2
-httplib2>=0.7
-python-gflags>=1.5
-urllib3>=1.3
-ws4py>=0.3
-PyYAML>=3.0
+#!/usr/bin/env python
+
+import os
+
from setuptools import setup, find_packages
+README = os.path.join(os.path.dirname(os.path.realpath(__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",
'urllib3',
'ws4py'
],
+ test_suite='tests',
+ tests_require=['PyYAML'],
zip_safe=False)
arv_put.ResumeCache.CACHE_DIR = orig_cachedir
os.chmod(cachedir, 0o700)
- def test_short_put_from_stdin(self):
- # Have to run this separately since arv-put can't read from the
- # tests' stdin.
- # arv-put usually can't stat(os.path.realpath('/dev/stdin')) in this
- # case, because the /proc entry is already gone by the time it tries.
- pipe = subprocess.Popen(
- [sys.executable, arv_put.__file__, '--stream'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.STDOUT)
- pipe.stdin.write('stdin test\n')
- pipe.stdin.close()
- deadline = time.time() + 5
- while (pipe.poll() is None) and (time.time() < deadline):
- time.sleep(.1)
- returncode = pipe.poll()
- if returncode is None:
- pipe.terminate()
- self.fail("arv-put did not PUT from stdin within 5 seconds")
- elif returncode != 0:
- sys.stdout.write(pipe.stdout.read())
- self.fail("arv-put returned exit code {}".format(returncode))
- self.assertIn('4a9c8b735dce4b5fa3acf221a0b13628+11', pipe.stdout.read())
-
def test_link_without_project_uuid_aborts(self):
self.assertRaises(SystemExit, self.call_main_with_args,
['--name', 'test without project UUID', '/dev/null'])
class ArvPutIntegrationTest(unittest.TestCase):
PROJECT_UUID = run_test_server.fixture('groups')['aproject']['uuid']
+ ENVIRON = os.environ
+ ENVIRON['PYTHONPATH'] = ':'.join(sys.path)
@classmethod
def setUpClass(cls):
else:
self.assertFalse(result, "incorrectly found nonexistent project")
+ def test_short_put_from_stdin(self):
+ # Have to run this as an integration test since arv-put can't
+ # read from the tests' stdin.
+ # arv-put usually can't stat(os.path.realpath('/dev/stdin')) in this
+ # case, because the /proc entry is already gone by the time it tries.
+ pipe = subprocess.Popen(
+ [sys.executable, arv_put.__file__, '--stream'],
+ stdin=subprocess.PIPE, stdout=subprocess.PIPE,
+ stderr=subprocess.STDOUT, env=self.ENVIRON)
+ pipe.stdin.write('stdin test\n')
+ pipe.stdin.close()
+ deadline = time.time() + 5
+ while (pipe.poll() is None) and (time.time() < deadline):
+ time.sleep(.1)
+ returncode = pipe.poll()
+ if returncode is None:
+ pipe.terminate()
+ self.fail("arv-put did not PUT from stdin within 5 seconds")
+ elif returncode != 0:
+ sys.stdout.write(pipe.stdout.read())
+ self.fail("arv-put returned exit code {}".format(returncode))
+ self.assertIn('4a9c8b735dce4b5fa3acf221a0b13628+11', pipe.stdout.read())
+
def test_ArvPutSignedManifest(self):
# ArvPutSignedManifest runs "arv-put foo" and then attempts to get
# the newly created manifest from the API server, testing to confirm
with open(os.path.join(datadir, "foo"), "w") as f:
f.write("The quick brown fox jumped over the lazy dog")
p = subprocess.Popen([sys.executable, arv_put.__file__, datadir],
- stdout=subprocess.PIPE)
+ stdout=subprocess.PIPE, env=self.ENVIRON)
(arvout, arverr) = p.communicate()
self.assertEqual(p.returncode, 0)
self.assertEqual(arverr, None)
pipe = subprocess.Popen(
[sys.executable, arv_put.__file__,
'--project-uuid', self.PROJECT_UUID] + extra_args,
- stdin=subprocess.PIPE,
- stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ stdin=subprocess.PIPE, stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE, env=self.ENVIRON)
stdout, stderr = pipe.communicate(text)
link_list = arvados.api('v1', cache=False).links().list(
filters=[['head_uuid', '=', stdout.strip()],
--- /dev/null
+========================
+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.
+++ /dev/null
-apt-get install python-dev libattr1-dev libfuse-dev pkg-config
+++ /dev/null
-arvados-python-client>=0.1
-llfuse>=0.37
-python-daemon>=1.5
#!/usr/bin/env python
-from setuptools import setup
+import os
+
+from setuptools import setup, find_packages
+
+README = os.path.join(os.path.dirname(os.path.realpath(__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",
'llfuse',
'python-daemon'
],
+ test_suite='tests',
+ tests_require=['PyYAML'],
zip_safe=False)
projects / arvados.git / commitdiff