README file for libtorrent/StatusParser.py

diff --git a/log-parser/libtorrent/README b/log-parser/libtorrent/README
new file mode 100644 (file)
index 0000000..8ec9438
--- /dev/null
+++ b/log-parser/libtorrent/README
@@ -0,0 +1,20 @@
+== StatusParser.py ==
+
+libtorrent status log files parser. A status log file is passed as argument.
+Lines are parsed and written to status_messages table in database.
+
+Its arguments are a client session id, the status filename and the
+database filename.
+
+** Draft **
+
+* At this point, there is no database interraction (DatabaseWriter.py
+function call is commented out).
+* Sample call:
+
+---
+razvan@valhalla:~/projects/p2p-next/cs-p2p-next/log-parser/libtorrent$ PYTHONPATH=../../auto/db/ python StatusParser.py -i 2 -f ../../log-samples/libtorrent/libtorrent-status.sample.log ../../auto/db/p2p-next.db 
+---
+
+* Some debug output messages can be enabled by initializing the DEBUG
+global variable in the StatusParser.py to True.