Skip to content

Latest commit

 

History

History
133 lines (104 loc) · 5.1 KB

README.md

File metadata and controls

133 lines (104 loc) · 5.1 KB

Prosimos Web Server

dependencies_badge

Docker Image CI

The open-source web server implemented as a part of the Prosimos Web Application.

Start the web server locally (via locally installed Python)

Prerequisites

  1. Create and activate a new virtual environment. Since poetry.toml defines in-project true, a virtual environment is created under /.venv path.

    poetry shell

  2. Install all required modules. They are listed in pyproject.toml.

    poetry install

  3. Start a Flask web server

    poetry run flask run

  4. The web server is now running and available here: http://localhost:5000/apidocs/. The page lists all available endpoints and describes its input and output parameters. The detailed overview of how to use the Swagger is available here under Swagger section. Documentation also includes the description of how curl can be used to perform the requests.

Start the web server locally (via Docker)

Please, note that you need to have Docker installed in order to follow the following steps. The installation instructions could be found here: https://docs.docker.com/get-docker/

  1. Pre-requisite step: Docker is running.
  2. Build the image from the current code version in the repository. 
    docker build --progress=plain --no-cache -f Dockerfile.api -t prosimos-api .
  3. Start the container 
    docker run --rm -p 5000:5000 prosimos-api
  4. The web server is now running and available here: http://localhost:5000/apidocs/. The page lists all available endpoints and describes its input and output parameters. The detailed overview of how to use the Swagger is available here under Swagger section. Documentation also includes the description of how curl can be used to perform the requests.

Access API endpoints

Curl
  1. Discover simulation parameters based on logs.
curl \
    -X POST "http://localhost:5000/api/discovery" \
    -H "accept: application/json" \
    -H "Content-Type: multipart/form-data" \
    -F "bpmnFile=@purchasing_example.bpmn" \
    -F "[email protected]"

where @purchasing_example.bpmn and @PurchasingExample.xes should be replaced with the full path to the file on your computer, for example, @"/Users/iryna/Documents/proposed.json"

  1. Perform the simulation
curl \
    -X POST "http://localhost:5000/api/simulate" \
    -H "accept: application/json" \
    -H "Content-Type: multipart/form-data" \
    -F "startDate=2022-05-03T12:05:19.1919+03:00" \
    -F "numProcesses=1" \
    -F "modelFile=@purchasing_example.bpmn" \
    -F "simScenarioFile=@discovery_results_mos9tbez.json;type=application/json"

where @purchasing_example.bpmn and @discovery_results_mos9tbez.json should be replaced with the full path to the file on your computer.

  1. Get files generated together with the simulation (logs and statistics).
curl \
    -X GET "http://localhost:5000/api/simulationFile?fileName=stats_kjv4fq1r.csv" \
    -H "accept: application/json"

where stats_kjv4fq1r.csv should be replaced with the filename which you want to get (the filename is being returned on /api/simulate call).

Swagger

To access Swagger and perform API calls directly from the web browser, you can access http://localhost:5000/apidocs/

swagger-ui

Development

Development notes

Release the new version of the API docker image

  1. Build the image from the current code version.

    docker build --progress=plain --no-cache -f Dockerfile.api -t prosimos-api .

  2. Get the image id of the created image in step 1

    docker images prosimos-api

  3. Tag the image specifying the version we will be releasing, e.g. 0.1.2

    docker tag 39a635198e63 irynahalenok/prosimos-api:0.1.2

  4. Push the created version to the Docker hub

    docker push irynahalenok/prosimos-api:0.1.2

  5. Tag the created version in git

    git tag v0.1.2 <SHA>

    where <SHA> should be changed to the SHA of the last commit in the release.

  6. Push the created tag

    git push origin v0.1.2