SLiMSuite REST Server


Links
REST Home
EdwardsLab Homepage
EdwardsLab Blog
SLiMSuite Blog
SLiMSuite
Webservers
REST Pages
REST Status
REST Help
REST Tools
REST Alias Data
REST API
REST News
REST Sitemap

SLiMParser V0.4.0

SLiMSuite REST output parsing tool.

Module: SLiMParser
Description: SLiMSuite REST output parsing tool.
Version: 0.4.0
Last Edit: 12/09/16

Copyright © 2014 Richard J. Edwards - See source code for GNU License Notice


Imported modules: rje rje_obj rje_html


See SLiMSuite Blog for further documentation.

Function

This module is for parsing the full REST output of a program into a couple of dictionaries, with options to output the data to files or convert to/from json format.

If restin=FILE is a URL, this will be interpreted as a REST command for API access. Use with rest=X and pureapi=T to print the output to STDOUT once the run is complete. Use in conjunction with v=-1 to avoid additional STDOUT output and silent=T to avoid log generation.

REST URLs can include files to be uploaded. These must be prefixed with file:, e.g. &seqin=file:input.fas. If the specified file exists then the content will replace the file name in the REST call.

Commandline

INPUT/OUTPUT OPTIONS

restin=FILE # Full REST output file, REST jobid (number), or full REST call URL (http://...) []
password=X # Optional password for REST jobid retrieval [None]
restout=T/F # Whether to save extracted elements to individual files [False]
rest=X # Return text for just the REST output element X []
restbase=X # Basefile for parsed REST output that lacks defined filename [jobid]
restoutdir=PATH # Path for output of parsed REST output [./]
pureapi=T/F # Whether to return the text returned from the REST call. Needs rest=X. [False]

REST API Options

resturl=X # URL of rest server ['http://rest.slimsuite.unsw.edu.au/']
refresh=X # Initial number of seconds for between checks for job status (will double) [5]
maxrefresh=X # Maximum number of seconds for incrementing check refresh [600]


See also rje.py generic commandline options.

History Module Version History

    # 0.0.0 - Initial Compilation.
    # 0.0.1 - Fixed RestKeys bug.
    # 0.1.0 - Added retrieval and parsing of existing server job. Added password.
    # 0.2.0 - Added API access to REST server if restin is REST call (i.e. starts with http:)
    # 0.2.1 - Added PureAPI output of API REST call returned text.
    # 0.3.0 - Added parsing of input files to give to rest calls.
    # 0.3.1 - Fixed issue that had broken REST server full output.
    # 0.3.2 - Fixed issue reading files for full output.
    # 0.3.3 - Tidied output names when restbase=jobid.
    # 0.3.4 - Tweaked error messages.
    # 0.4.0 - Added simple json format output.

© 2015 RJ Edwards. Contact: richard.edwards@unsw.edu.au.