Commit f50f4dc9 authored by Roland Haas's avatar Roland Haas
Browse files

Add README file

parent 5285bec4
GlobusTransferHelper
====================
What is this?
---------------
GlobusTransferHelper is a utility python package to be used with the Python API
to [Globus](http://globus-sdk-python.readthedocs.io/en/latest/). It aims to
simplify common tasks and reduce the number of cide lines needed for simple
tasks.
Installation
------------
There is currently no installer or `setup.py` provided, so installation consists
of downloading the code and putting it somewhere whitin your `$PYTHONPATH`.
Usage
-----
When used as a python(3) module the helper is used like this:
```#python
import globustransferhelper
hlp = globustransferhelper.GlobusTransferHelper()
files = hlp.ls(globustransferhelper.EP_BLUEWATERS, "~")
print (files.keys())
```
The module can also be called from the command line, in which case it will log
you in to Globus and activate the BlueWaters and NearLine endpoints.
```#bash
./globustransferhelper.py
```
Examples
--------
The file `showcase_helper.py` in this repository demonstrates most functionality
in the code.
Authors
-------
* the Blue Waters SEAS team
* Galen Arnold
* Roland Haas
TODO
----
1. add `setup.py` to enable installation via `pip` etc.
1. add more useful python docstrings
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment