DOCUMENTATION
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:
make VOSpace appear as mounted filesystem: mountvofs
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
Get a CANFAR account
Install the vosfs package.
Retrieve a X509/SSL certificate using the installed in cadc-get-cert script.
Example Usage.
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
Metadata
Release files for vofs 3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vofs-3.1.tar.gz | 57.2 kB | Without provenance | Details for vofs-3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vofs-3.1-py3-none-any.whl | Python 3 | none | any | Details for vofs-3.1-py3-none-any.whl |
Total release size: 109.5 kB
Release files / vofs-3.1.tar.gz
| Download URL | vofs-3.1.tar.gz |
|---|---|
| Size | 57.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e209b07b2e667007247fe2a59a5181e12ae284b916cfac2dace3fff8f5e5d03e
|
|
BLAKE2b-256 checksum How to use checksums |
bbc53da67a7df6c5be149c2b341eee825bc549d2051e12a26899ef6ae7ef8d56
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
Release files / vofs-3.1-py3-none-any.whl
| Download URL | vofs-3.1-py3-none-any.whl |
|---|---|
| Size | 52.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fe32bec8cfff2b3de54e419ad998d79ae720c6f005df9699fd23957a1e3e368c
|
|
BLAKE2b-256 checksum How to use checksums |
cebf6aaf899d58d72e628c82611d6f7fba2a6297f889465ec4aeccb9e290db80
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
Security for vofs 3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.