[Nym3-commit] r296 - in trunk/nym3: . Client Server

[jr at conuropsis.org]

Author: jr
Date: 2005-06-12 10:32:49 +0200 (Sun, 12 Jun 2005)
New Revision: 296

Modified:
   trunk/nym3/Client/Account.py
   trunk/nym3/Client/Keyring.py
   trunk/nym3/Client/Main.py
   trunk/nym3/Client/testcurses.py
   trunk/nym3/Common.py
   trunk/nym3/Crypto.py
   trunk/nym3/Mail.py
   trunk/nym3/Message.py
   trunk/nym3/Server/Config.py
   trunk/nym3/Server/Main.py
   trunk/nym3/Server/User.py
Log:
add some doc strings


Modified: trunk/nym3/Client/Account.py
===================================================================
--- trunk/nym3/Client/Account.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Client/Account.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -22,9 +22,11 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""Contains user account information on the client side
-+ way to create, access and modify them"""
+"""nym3.Client.Acount
 
+    This package contains user account information representation on the client
+    side and ways to create, access to and modify them."""
+
 import copy
 import os
 import nym3.Client.Config as Config

Modified: trunk/nym3/Client/Keyring.py
===================================================================
--- trunk/nym3/Client/Keyring.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Client/Keyring.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -23,6 +23,11 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""nym3.Client.KeyRing
+
+    This package contains the implementation of a Keyring designed to store
+    keys in files protected by a password and to easily access those keys."""
+
 import pickle
 import random
 import nym3.Mail as Mail

Modified: trunk/nym3/Client/Main.py
===================================================================
--- trunk/nym3/Client/Main.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Client/Main.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -23,8 +23,10 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""The implementation of a client"""
+"""nym3.Client.Main
 
+    This package contains the implementation of a nym3 command line client."""
+
 import sys
 import os
 import string

Modified: trunk/nym3/Client/testcurses.py
===================================================================
--- trunk/nym3/Client/testcurses.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Client/testcurses.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -22,6 +22,11 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""nym3.Client.testcurses
+
+    This package contains an attempt at writing a curses based nym3 interface.
+    It is not working for now, but may be adapted in the future."""
+
 import curses
 import curses.wrapper
 import curses.ascii

Modified: trunk/nym3/Common.py
===================================================================
--- trunk/nym3/Common.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Common.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -22,8 +22,10 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""Stuff used by both the server and our client"""
+"""nym3.Common
 
+    This packages contains constants used by both the server and our client."""
+
 #constants
 
 sigLength = 256

Modified: trunk/nym3/Crypto.py
===================================================================
--- trunk/nym3/Crypto.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Crypto.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -23,7 +23,11 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-
+"""nym3.Crypto
+  
+    This package contains all the specific cryptographic primitives defined
+    in Nym spec."""
+    
 import random
 import mixminion.Packet as _mp
 import mixminion.Crypto as _cr

Modified: trunk/nym3/Mail.py
===================================================================
--- trunk/nym3/Mail.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Mail.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -22,8 +22,10 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""Contains utilities to process mails"""
+"""nym3.Mail
 
+    This package contains utilities to process mails."""
+
 import re
 import os
 import tempfile

Modified: trunk/nym3/Message.py
===================================================================
--- trunk/nym3/Message.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Message.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -24,9 +24,11 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""This module contains representations of the message of the protocol
-and methods to parse and generate messages from these representation"""
+"""nym3.Message
 
+    This module contains representations of the message of the nym protocol
+    and methods to parse and generate messages from these representations."""
+
 import types
 import nym3.Common as Common
 import mixminion.Crypto as _cr

Modified: trunk/nym3/Server/Config.py
===================================================================
--- trunk/nym3/Server/Config.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Server/Config.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -22,8 +22,10 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""The configuration file of the server."""
+"""nym3.Server.Config
 
+    This package is the configuration file of the server."""
+
 __all__ = ['DEBUG', "serverName", "path", "default_settings"]
 #path = '/var/lib/nym3'
 

Modified: trunk/nym3/Server/Main.py
===================================================================
--- trunk/nym3/Server/Main.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Server/Main.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -24,8 +24,10 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""The implementation of the server."""
+"""nym3.Server.Main
 
+    This package contains an implementation of a nym3 server."""
+
 import sys
 import os
 import getopt

Modified: trunk/nym3/Server/User.py
===================================================================
--- trunk/nym3/Server/User.py	2005-06-11 23:52:43 UTC (rev 295)
+++ trunk/nym3/Server/User.py	2005-06-12 08:32:49 UTC (rev 296)
@@ -23,9 +23,11 @@
 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-"""This module contains methods of storing, accessing and editing user account
-information."""
+"""nym3.Server.User
 
+    This module contains methods of storing, accessing and editing user account
+    information."""
+
 import os
 import nym3.Server.Config as Config
 import nym3.Common as Common