techbloc/techrec
1
0
Fork 0
Code Issues 10 Pull requests Releases Activity

readme

Browse source
This commit is contained in:
boyska 2013-11-26 14:31:18 +01:00
parent f1227c2f57
commit 0348e2cc2e
1 changed files with 36 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

91
README.md
View file

@ -1,62 +1,43 @@
==========================================
techrec
==========================================
TECHREC
=======
BUG and roadmap
See roadmap for details
A Python2 web application that assist radio speakers in recording their shows.
At the moment, it relies on some details that are specific of our radio (like
the directory/format of the continous recording).
--------
Client
Implementation details
======================
It is based on bottle, to get a minimal framework. Rest APIs are offered
through it, and the static site uses them.
Create
--------
The Client is a JS script that exchange data with server via JSON
--------
Server
--------
The Server is a python software and uses the bottle library to implements a web
services
Data Format
===================================
--------
Create
--------
JSON = {
'starttime-rec-1385231288390': '2013/11/23 19:32:49',
'endtime-rec-1385231288390': '2013/11/23 19:32:49',
'recid': 'rec-1385231288390',
'name-rec-1385231288390': 'adasd',
'op': 'new'
}
--------
Retrieve
--------
--------
Update
--------
JSON = {
'starttime-rec-1385231288390': '2013/11/23 19:32:49',
'endtime-rec-1385231288390': '2013/11/23 19:32:49',
'recid': 'rec-1385231288390', ### VALID REC ID
'name-rec-1385231288390': 'adasd',
'op': 'update'
}
--------
Delete
--------
JSON = {
'recid': 'rec-1385231288390', ### VALID REC ID
'op': 'delete'
}
JSON = {
'starttime-rec-1385231288390': '2013/11/23 19:32:49',
'endtime-rec-1385231288390': '2013/11/23 19:32:49',
'recid': 'rec-1385231288390',
'name-rec-1385231288390': 'adasd',
'op': 'new'
}
Update
-------
JSON = {
'starttime-rec-1385231288390': '2013/11/23 19:32:49',
'endtime-rec-1385231288390': '2013/11/23 19:32:49',
'recid': 'rec-1385231288390', ### VALID REC ID
'name-rec-1385231288390': 'adasd',
'op': 'update'
}
Delete
------
JSON = {
'recid': 'rec-1385231288390', ### VALID REC ID
'op': 'delete'
}