Skip to main content

XRootDPyFS is a PyFilesystem interface to XRootD.

Project description

https://travis-ci.org/inveniosoftware/xrootdpyfs.svg?branch=master https://coveralls.io/repos/inveniosoftware/xrootdpyfs/badge.svg?branch=master https://pypip.in/v/xrootdpyfs/badge.svg

XRootDPyFS is a PyFilesystem interface to XRootD.

Getting started

If you just want to try out the library, the easiest is to use Docker.

$ docker build -t xrootd .
$ docker run -h xrootdpyfs -it xrootd bash

Next, start a XRootD server in the container and fire up an ipython shell:

[xrootdpyfs@xrootdpyfs code]$ xrootd -b -l /dev/null
[xrootdpyfs@xrootdpyfs code]$ ipython

Quick examples

Here is a quick example of a file listing with the xrootd PyFilesystem integration:

>>> from xrootdpyfs import XRootDPyFS
>>> fs = XRootDPyFS("root://localhost//tmp/")
>>> fs.listdir("xrootdpyfs")
['test.txt']

Or, alternatively using the PyFilesystem opener (note the first import xrootdpyfs is required to ensure the XRootDPyFS opener is registered):

>>> import xrootdpyfs
>>> from fs.opener import opener
>>> fs, path = opener.parse("root://localhost//tmp/")
>>> fs.listdir("xrootdpyfs")
[u'test.txt']

Reading files:

>>> f = fs.open("xrootdpyfs/test.txt")
>>> f.read()
'Welcome to xrootdpyfs!'
>>> f.close()

Reading files using the getcontents() method:

>>> fs.getcontents("xrootdpyfs/test.txt")
'Welcome to xrootdpyfs!'

Writing files:

>>> f = fs.open("xrootdpyfs/hello.txt", "w+")
>>> f.write("World")
>>> f.close()

Writing files using the setcontents() method:

>>> fs.setcontents("xrootdpyfs/test.txt", "World")

Documentation

Documentation is available at <http://xrootdpyfs.readthedocs.io/> or can be build using Sphinx:

pip install Sphinx
python setup.py build_sphinx

Testing

Running the tests are most easily done using docker:

$ docker build -t xrootd . && docker run -h xrootdpyfs -it xrootd

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

xrootdpyfs-0.1.5.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

xrootdpyfs-0.1.5-py2-none-any.whl (20.8 kB view details)

Uploaded Python 2

File details

Details for the file xrootdpyfs-0.1.5.tar.gz.

File metadata

  • Download URL: xrootdpyfs-0.1.5.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xrootdpyfs-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fa49e38d1fbd4a1963d9b08061df65a1b237ed5f0e9665182760ca1240d24025
MD5 97f395058a9045c4f39115d9b2fdc82b
BLAKE2b-256 8d1a30ff00aca7fa3d3d01e5827e1af4ab46ce080bba8070a4744603b64eed8d

See more details on using hashes here.

Provenance

File details

Details for the file xrootdpyfs-0.1.5-py2-none-any.whl.

File metadata

File hashes

Hashes for xrootdpyfs-0.1.5-py2-none-any.whl
Algorithm Hash digest
SHA256 247d30df973073c773eff58bb1e3d423f5781c47df7ffa6b7d8a8f4a96ede8d2
MD5 f4c6abe03e058339edebb30769453ae3
BLAKE2b-256 dda9c25b18e40afe332fbfe846ce989b1c09c2bff33f5fc200b4657a25f619c2

See more details on using hashes here.

Provenance

Supported by

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