download in pdf format
Status: in progress

Motivation

Make the various command line scripts available on local network and later on public web.

Main expected benefits:

  • platform independent
  • easy to find
  • sharable (command line skills not required to use it)

Design ideas

Reproducibility:

  • each application is inside a docker container
  • as few dependencies as possible
  • deployed through git

Easy to create

  • It is easy to understand what is doing what
  • As basic html and libraries as possible
  • The same structure for all of them
  • The main code on the backend is the same as the command line utility

General design outline

1. README

General info about how to run the application, notes from the development

2. Docker setup

  • Dockerfile
  • docker-compose.yml

3. Python environment

  • requirments.txt

4. app.py

  • defines the logic
  • uses the script.py
  • uses the html templates

5. script.py

  • identical to the command line tool
  • contains usage which should be displayed on the page of the app

6. html templates

  • blocks displayed on the pages (form can be one template) or whole pages

7. jobs

  • directory which contains the analyzed data (should be periodically erased)

8. examples

  • files to download to test if the app is working

app.py

to be filled in