vofs 3.0.0b5

System Requirments

• A CANFAR VOSpace account (required for WRITE access, READ access can be anonymous)

• fuse OR OSX-FUSE (see additional documentation, only required for filesystem based access, not for command line or programmatic)

• python2.6 or later

Installation

vosfs is distributed via PyPI/vos and PyPI is the most direct way to get the latest stable release:

pip install vosfs --upgrade --user

Or, you can retrieve the github distribution and use

python setup.py install --user

Tutorial

1. Get a CANFAR account

2. Install the vosfs package.

3. Retrieve a X509/SSL certificate using the installed in cadc-get-cert script.

4. Example Usage.

   1. For filesystem usage: mountvofs mounts the CADC VOSpace root Container Node at /tmp/vospace and initiates a 5GB cache in the users home directory (${HOME}/vos_). fusermount -u /tmp/vospace (LINUX) or umount /tmp/vospace (OS-X) unmounts the file system. VOSpace does not have a mapping of your unix users IDs and thus files appear to be owned by the user who issued the ‘mountvofs’ command.

Development

A virtual environment (venv) is recommended to set up external dependencies without installing them system-wide. Following these instructions, install virtualenv:

$ pip install virtualenv

Next, create, and activate a local venv (this example uses bash):

$ virtualenv venv
$ source venv/bin/activate

Setup the new development environment for testing by installing the appropriate packages:

$ pip install -r dev_requirements.txt

The test environment is built into the setup.py so that conducting unit-tests can be achieved like so:

python setup.py test

If you would like versbose output formated as a web page, for example, you can add options to the test call:

python setup.py test --addopts '--cov-report html:cov_html --cov=vosfs'

The same option attribute can be used to pass other arguments to py.test that is executing the test. To run specific only tests for example:

python setup.py test --addopts 'vos/test/Test_vos.py::TestClient::test_transfer_error'

Each time you resume work on the project and want to use the venv (e.g., from a new shell), simply re-activate it:

$ source venv/bin/activate

When done, just issue a

$ deactivate

command to deactivate the virtual environment.

$ source venv/bin/activate.csh
$ pip install vofs