[or-cvs] r12816: Add a launch module, and a README. (in bridgedb/trunk: . lib lib/bridgedb)

[nickm at seul.org]

Author: nickm
Date: 2007-12-14 16:18:37 -0500 (Fri, 14 Dec 2007)
New Revision: 12816

Added:
   bridgedb/trunk/lib/TorBridgeDB.py
Modified:
   bridgedb/trunk/
   bridgedb/trunk/README
   bridgedb/trunk/TODO
   bridgedb/trunk/lib/bridgedb/Main.py
   bridgedb/trunk/setup.py
Log:
 r17156 at catbus:  nickm | 2007-12-14 16:18:29 -0500
 Add a launch module, and a README.



Property changes on: bridgedb/trunk
___________________________________________________________________
 svk:merge ticket from /bridgedb/trunk [r17156] on 8246c3cf-6607-4228-993b-4d95d33730f1

Modified: bridgedb/trunk/README
===================================================================
--- bridgedb/trunk/README	2007-12-14 21:06:02 UTC (rev 12815)
+++ bridgedb/trunk/README	2007-12-14 21:18:37 UTC (rev 12816)
@@ -1,7 +1,25 @@
 
-Empty readme file.  Write this.
+To set up:
+ - Install Python 2.4 or later.
+ - Install Twisted-Web, Twisted-Mail, PyOpenSSL, and all their dependencies.
+ - python setup.py --prefix=$HOME
+ - Edit bridgedb.conf; put it somewhere good.
+ - Make sure that the input files referred to in bridgedb.conf exist.
+ - Set up PYTHONPATH to include "~/lib/python2.4/site-packages/".
 
- - You'll need Python 2.4 or later.
+To run:
+ - Run "python -m TorBridgeDB bridgedb.conf"
 
+ - When you have new lists of bridges, replace the old files and send the
+   process a sighup.
+
+To use with HTTPS:
+ - Just connect to the appropriate port.
+
+To use with email:
+ - Any mail sent to the email port with a subject or a single line _exactly_
+   equal to "get bridges" will get answered, assuming the domain is okay.
+
+Support
  - Send your questions to nickm.
 

Modified: bridgedb/trunk/TODO
===================================================================
--- bridgedb/trunk/TODO	2007-12-14 21:06:02 UTC (rev 12815)
+++ bridgedb/trunk/TODO	2007-12-14 21:18:37 UTC (rev 12816)
@@ -19,4 +19,6 @@
 - decent template for web interface
 - decent template for mail interface
 - implement 'help' command
-- Reload configuration on sighup; not just bridges.
\ No newline at end of file
+- Reload configuration on sighup; not just bridges.
+- Reply with locale support.
+- Check host option in http

Added: bridgedb/trunk/lib/TorBridgeDB.py
===================================================================
--- bridgedb/trunk/lib/TorBridgeDB.py	                        (rev 0)
+++ bridgedb/trunk/lib/TorBridgeDB.py	2007-12-14 21:18:37 UTC (rev 12816)
@@ -0,0 +1,4 @@
+#!/usr/bin/python
+
+import bridgedb.Main
+bridgedb.Main.run()

Modified: bridgedb/trunk/lib/bridgedb/Main.py
===================================================================
--- bridgedb/trunk/lib/bridgedb/Main.py	2007-12-14 21:06:02 UTC (rev 12815)
+++ bridgedb/trunk/lib/bridgedb/Main.py	2007-12-14 21:18:37 UTC (rev 12816)
@@ -173,7 +173,7 @@
         if dblogfile is not None:
             dblogfile.close()
 
-if __name__ == '__main__':
+def run():
     if len(sys.argv) != 2:
         print "Syntax: %s [config file]" % sys.argv[0]
         sys.exit(1)
@@ -184,3 +184,6 @@
         execfile(sys.argv[1], configuration)
 
     startup(CONFIG)
+
+if __name__ == '__main__':
+    run()

Modified: bridgedb/trunk/setup.py
===================================================================
--- bridgedb/trunk/setup.py	2007-12-14 21:06:02 UTC (rev 12815)
+++ bridgedb/trunk/setup.py	2007-12-14 21:18:37 UTC (rev 12816)
@@ -40,6 +40,7 @@
       url='https://www.torproject.org',
       package_dir= {'' : 'lib'},
       packages=['bridgedb'],
+      py_modules=['TorBridgeDB'],
       cmdclass={'test' : runTests}
       )