Skip to main content

Class Libraries for VOSpace file system

Project description

https://img.shields.io/pypi/v/vofs.svg

vosfs is a python module that allows a VOSpace service to be used as a file system.

The default installation of vosfs is tuned for accessing the VOSpace provided by the Canadian Advanced Network For Astronomical Research (CANFAR)

VOSpace is a Distributed Cloud storage service for use in Astronomy.

There are two ways to use vos:

  1. make VOSpace appear as mounted filesystem: mountvofs

  2. use the vosfs module inside a Python script: import vosfs

Authentication to the CANFAR VOSpace service is performed using X509 security certificates, header tokens or username/password pairs. The authentication system is managed by the CADC Group Management Service (GMS).

To retrieve an X509 security certificate for use with the vosfs tools use the cadc-get-cert script included with the cadcutils package.

Additional information is available in the CANFAR documentation

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.

Integration Tests

The integration tests are, at present, designed to run only with the CADC VOSpace. Tests assume that the vofs package has been installed.

Run the tests:

``` $ ./test/scripts/vospace-mountvospace-atest.tcsh

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vofs-3.1.tar.gz (57.2 kB view details)

Uploaded Source

Built Distribution

vofs-3.1-py3-none-any.whl (52.3 kB view details)

Uploaded Python 3

File details

Details for the file vofs-3.1.tar.gz.

File metadata

  • Download URL: vofs-3.1.tar.gz
  • Upload date:
  • Size: 57.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for vofs-3.1.tar.gz
Algorithm Hash digest
SHA256 e209b07b2e667007247fe2a59a5181e12ae284b916cfac2dace3fff8f5e5d03e
MD5 ad8c9f6ca2f51af435ee42ccdfbd1305
BLAKE2b-256 bbc53da67a7df6c5be149c2b341eee825bc549d2051e12a26899ef6ae7ef8d56

See more details on using hashes here.

File details

Details for the file vofs-3.1-py3-none-any.whl.

File metadata

  • Download URL: vofs-3.1-py3-none-any.whl
  • Upload date:
  • Size: 52.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for vofs-3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe32bec8cfff2b3de54e419ad998d79ae720c6f005df9699fd23957a1e3e368c
MD5 ce86a8feabec26ce549bc085b6b7c779
BLAKE2b-256 cebf6aaf899d58d72e628c82611d6f7fba2a6297f889465ec4aeccb9e290db80

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page