From 19cf564aa9e2c05a80690155b6e33d5672a83f22 Mon Sep 17 00:00:00 2001 From: boyska Date: Fri, 13 Dec 2013 17:59:46 +0100 Subject: [PATCH] Readme --- README.md | 46 ++++++++++++++++++++-------------------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 94329c2..b58b85a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,25 @@ -TECHREC +TechRec ======= 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). +It is however quite simple to change that specific portion of code, as it is +modular and all in `forge.py` +Features +========= + +* The interface is extremely simple to use +* You can have nested recording (ie: to record an interview inside of a whole + show) +* There is no user system: any user opening the website will see the complete + status of the applications. There is, also, nothing stored in cookie or + similar mechanisms. This means that recording a session does not require a + browser to remain open, or any kind of persistence client-side: server-side + does it all. +* The audio generation has a simple design, so switching from `ffmpeg` to, + say, `vlc` is simple Implementation details ====================== @@ -12,29 +27,8 @@ Implementation details It is based on bottle, to get a minimal framework. Simple APIs are offered through it, and the static site uses them. -Here are some examples of APIs usage +Jobs are not dispatched using stuff like celery, but with a thin wrapper over +`multiprocessing.Pool`; this is just to keep the installation as simple as +possible. -Create --------- - - 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 -------- - - 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: update - - -Delete ------- - - recid: rec-1385231288390 - op: delete +The encoding part is delegated to `ffmpeg`