PySafeAPI

html export of the self-documenting script

A python wrapper around the Safe Launcher API.

Installation

PySafeAPI is installable from PyPi using the following command:

pip install SafeAPI

This will not include the examples which are downloadable by cloning this repository.

Progress

Authorization

• POST /auth
• GET /auth
• DELTE /auth

NFS Directory

• POST /nfs/directory/:rootPath/:directoryPath
• GET /nfs/directory/:rootPath/:directoryPath/
• PUT /nfs/directory/:rootPath/:directoryPath
• POST /nfs/movedir
• DELETE /nfs/directory/:rootPath/:directoryPath

NFS File

• POST /nfs/file/:rootPath/:filePath
• HEAD /nfs/file/:rootPath/:filePath
• GET /nfs/file/:rootPath/:filePath
• PUT /nfs/file/metadata/:rootPath/:filePath
• POST /nfs/movefile
• DELETE /nfs/file/:rootPath/:filePath

DNS

• POST /dns/:longName
• POST /dns
• PUT /dns
• GET /dns
• GET /dns/:longName
• GET /dns/:serviceName/:longName
• GET /dns/:serviceName/:longName/:filePath
• DELETE /dns/:serviceName/:longName
• DELETE /dns/:longName

Examples

A selection of examples are located in the examples folder. They can be run using the following command

python -m examples.EXAMPLE_NAME

E.g To run the upload webpage example run

python -m examples.upload_webpage

Contributions

If you would like to contribute to the development of this project please feel free to submit a pull request.

Pull requests should be submitted to the current development branch. Pull requests to master may be rejected.

Contributions for any of the missing URLs, extra examples, documentation and bug fixes are all welcome.