Browse Source

documentation, to make things more realistic

Steve L. Nyemba 8 years ago
parent
commit
43b93abd54
2 changed files with 15 additions and 0 deletions
  1. 7 0
      requirements.txt
  2. 8 0
      src/api/index.py

+ 7 - 0
requirements.txt

@@ -0,0 +1,7 @@
+click==6.6
+Flask==0.11.1
+itsdangerous==0.24
+Jinja2==2.8
+MarkupSafe==0.23
+Werkzeug==0.11.11
+wheel==0.24.0

+ 8 - 0
src/api/index.py

@@ -1,4 +1,12 @@
+"""
+	This is a RESTful interface implemented using Flask micro framework.
+	The API is driven by configuration that is organized in terms of the monitoring classes
 
+	We designed the classes to be reusable (and powered by labels):
+	'monitoring-type':
+		'class':'<class-name>'
+		'config':<labeled-class-specific-configuration>'
+"""
 from flask import Flask,request
 import sys
 import os