Changeset 222 for cleverbox

Timestamp:

02/13/08 20:33:03 (4 years ago)

Author:

trivoallan

Message:

cleverbox :

• documentation cleanup
• started implementation of parameter checking method

Location:

cleverbox/trunk

Files:

• cleverbox/model/__init__.py (modified) (1 diff)
• cleverbox/model/client.py (modified) (1 diff)
• cleverbox/model/project.py (modified) (2 diffs)
• docs/README (modified) (1 diff)
• docs/TODO (modified) (2 diffs)

cleverbox/trunk/cleverbox/model/__init__.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 version = '0.5dev'
+
+def check_required_parameters(names, parameters):
+    
+    for required_param in names:
+        # This will raise a KeyError if a parameter is missing
+        # TODO : it could be better to raise a more specific exception
+        parameters[required_param]

cleverbox/trunk/cleverbox/model/client.py

@@ -137 +137 @@
     Deletes client from supplied environment.
     
-    TODO : tunr that into an "archive" command to avoid complete loss of data
+    TODO : turn that into an "archive" command to avoid complete loss of data
     """
     

cleverbox/trunk/cleverbox/model/project.py

@@ -5 +5 @@
 import logging, os, re, ConfigParser, traceback
 from cleverbox.utils import filesystem, styles
+from cleverbox import model
 
 def exists(environment, client_name, project_name, project_status = None):
@@ -87 +88 @@
     """
     
-    # Parameters required for project creation
-    required = ('client', 'short_name', 'full_name', 'profile', 'enable')
-
     # Merging for consistency
     parameters['client'] = client_name
     parameters['short_name'] = project_name
 
-    # Sanity checks before project creation
-    for required_param in required:
-        # This will raise a KeyError if a parameter is missing
-        # TODO : it could be better to raise a more specific exception
-        parameters[required_param]
-    
+    # Check that all required parameters are here
+    required = ('client', 'short_name', 'full_name', 'profile', 'enable')
+    model.check_required_parameters(required, parameters)
+
     # Make sure client exists
     from cleverbox.model import client

cleverbox/trunk/docs/README

@@ -1 @@
-The Cleverbox sits on top of [http://trac.edgewall.org Trac] and [http://subversion.tigris.org Subversion].
-It provides an interactive shell for deploying and maintaining instances of both projects.
+'''Please note : this version of the cleverbox is highly instable and should not be used in production. Latest stable version is cleverbox-0.4.'''
 
-== Features ==
+== What is it ? ==
 
- * Configuration profiles :
-   * Apache configuration templates
-   * `trac.ini` configuration template
-   * Default permissions
- * Easy to setup
- * Easy to use
- * Upgrade scripts provided with each new release (as of 0.4)
+The cleverbox provides an interactive command line shell dedicated to the deployment and maintenance of trac and subversion instances.
 
-== Non-goals ==
+It can handle multiple configuration profiles, enabling the deployment of differently flavored type of project (trac configuration and permissions, apache configuration templates, etc).
 
-This project does not have these features and will not get them anytime :
-
- * A web frontend
- * Full fledged plugins support
- * Multi-project Trac
- 
-Why ? Because this script is meant to stay simple. If you want that you'd better checkout [http://www.kforgeproject.com/ KForge] which has the 
-same feature set as the Cleverbox + a [http://www.djangoproject.com django]-based web frontend and very nice plugins integration (for providing new services). 
-Caveats : difficult to install and a bit instable at the moment (but i'm confident it will get better with 0.14 & following releases). 
+Project's main objective is to make your life as simple as possible. Thus, it comes with easy installation, easy upgrades and a comprehensive documentation.
 
 == License ==

cleverbox/trunk/docs/TODO

@@ -1 @@
-Cleverbox : modules reorganisation :
+== Cleverbox : modules reorganisation ==
 
  * cleverbox.utils.logging
+ * model.* -> domain.*
  
-Misc :
+== Misc ==
  * trac.ini "cleverbox" section (instead of incompatible string substition)
  * streamline cli / log output
@@ -11 +12 @@
  * apachectl integration (for configtest + reload)
  * by default, files should be owned bu current user, not root : 2.0 !
- * make code for collecting user input more generic 
- (and btw, models should not be responsible for collecting data)
  * normalize exceptions usage
  * trac permissions definitions could be better. Foreach subject listed in permissions.ini
    * revoke all permissions (list obtained with 'permissions list'
    * add permissions listed in permissions.ini
+ * Refactor to command pattern