Skip to content

Latest commit

 

History

History
128 lines (70 loc) · 4.16 KB

README.rst

File metadata and controls

128 lines (70 loc) · 4.16 KB
Raw
https://codecov.io/gh/scailfin/rob-webapi-flask/branch/master/graph/badge.svg?token=iE1ZYCA0lS
ROB Web Service Implementation (using Flask)

About

This is the default RESTful Web API implementation for the Reproducible Open Benchmarks for Data Analysis Platform (ROB) using the Flask web framework.

Installation and Configuration

The following installation instructions assume that you install all packages in a local folder ~/projects/rob.

# -- Change the working directory

cd ~/projects/rob

The Reproducible Open Benchmarks platform is implemented in Python. We recommend using a virtual environment for the installation.

# -- Create a new virtual environment
virtualenv venv
# -- Activate the virtual environment
source venv/bin/activate

The Flask Web API for ROB requires the flowserv package. The following steps will install all packages from the respective GitHub repositories:

git clone [email protected]:scailfin/flowserv-core.git
pip install -e flowserv-core
git clone [email protected]:scailfin/rob-webapi-flask.git
pip install -e rob-webapi-flask

The primary configuration parameters are defined in the ROB Configuration documentation. Two additional environment variables are defined by the Web API:

  • ROB_WEBAPI_LOG: Directory path for API logs (default: $FLOWSERV_API_DIR/log)
  • ROB_WEBAPI_CONTENTLENGTH: Maximum size of uploaded files (default: 16MB)

If you run the Flask application from the command line in developer mode using flask run, you also need to set the following environment variables:

export FLASK_APP=robflask.api
export FLASK_ENV=development

There are also more detailed instructions on the Demo Setup site to setup and run the Web API.

Command Line Interface

The robflask package includes a command line tool to setup the ROB database and for creating and manipulating benchmarks.

Initialize the ROB database

Initialize database and base directories for the Reproducible Open Benchmarks (ROB) Web API. The configuration parameters for the database are taken from the respective environment variables. Creates the API base directory if it does not exist.

Usage: flowserv init [OPTIONS]

  Initialize database and base directories for the API.

Options:
  -f, --force  Create database without confirmation
  --help       Show this message and exit.

Create and delete Benchmarks

Create a new benchmark.

Usage: flowserv workflows create [OPTIONS] TEMPLATE

  Create a new workflow.

Options:
  -n, --name TEXT          Unique workflow name.
  -d, --description TEXT   Short workflow description.
  -i, --instructions PATH  File containing instructions for running the
                           workflow.

  -f, --specfile FILE      Optional path to workflow specification file.
  -m, --manifest FILE      Optional path to workflow manifest file.
  --help                   Show this message and exit.

Delete a given benchmark.

Usage: flowserv workflows delete [OPTIONS] IDENTIFIER

  Delete a given workflow.

Options:
  --help  Show this message and exit.