Code and docs cleanup.

Jan Schrewe · Jan Schrewe · commit 915dc5323e3d · 2011-09-21T16:10:14.000+02:00
diff --git a/mongodbforms/documentoptions.py b/mongodbforms/documentoptions.py
@@ -3,10 +3,12 @@
 from django.db.models.fields import FieldDoesNotExist
 from django.db.models.loading import app_cache_ready
 
-from mongoengine.fields import ReferenceField, ObjectIdField
-from pymongo.objectid import ObjectId
+from mongoengine.fields import ReferenceField
 
 class PkWrapper(object):
+    """
+    Wraps an immutable class (like mongoengine's pk field) so that attributes can be added.
+    """
     def __init__(self, baseObject):
         self.__class__ = type(baseObject.__class__.__name__, (self.__class__, baseObject.__class__), {})
         self.__dict__ = baseObject.__dict__
@@ -15,7 +17,7 @@ def __init__(self, baseObject):
 class AdminOptions(object):
     """
     Used to store mongoengine's _meta dict to make the document admin
-    as compatible as possible to the django admin class.
+    as compatible as possible to django's meta class on models. 
     """
     def __init__(self, document):
         self.index_background = None
@@ -71,6 +73,12 @@ def init_from_meta(self):
         
             
     def init_pk(self):
+        """
+        Adds a wrapper around the documents pk field. The wrapper object gets the attributes
+        django expects on the pk field, like name and attname.
+        
+        The function also adds a _get_pk_val method to the document.
+        """
         if self.id_field is not None:
             try:
                 pk_field = getattr(self.document, self.id_field)
@@ -148,10 +156,7 @@ def get_field(self, name, many_to_many=True):
         """
         Returns the requested field by name. Raises FieldDoesNotExist on error.
         """
-        for f in self.document._fields.itervalues():
-            if f.name == name:
-                return f
-        raise FieldDoesNotExist('%s has no field named %r' % (self.object_name, name))
+        return self.get_field_by_name(name)
 
     def __getitem__(self, key):
         return self.meta[key]
diff --git a/mongodbforms/fields.py b/mongodbforms/fields.py
diff --git a/mongodbforms/util.py b/mongodbforms/util.py
@@ -2,7 +2,6 @@
 
 from mongotools.forms.fields import MongoFormFieldGenerator as MongotoolsGenerator
 
-from fields import ReferenceField
 from documentoptions import AdminOptions
 
 def init_document_options(document):
diff --git a/readme.md b/readme.md
@@ -5,6 +5,7 @@ This is an implementation of django's model forms for mongoengine documents.
 ## Requirements
 
  * [mongoengine](http://mongoengine.org/)
+ * [mongotools](https://github.com/wpjunior/django-mongotools)
 
 ## Usage
 
@@ -42,52 +43,3 @@ django-mongodbforms currently only supports the most basic things and even they
 
 
 
-
-
-
-
-
-
-
-
-An implementation of django's model forms for mongoengine documents. I am aware that there is already a [similar project](https://github.com/stephrdev/django-mongoforms), but I needed support for django's `modelform_factory` and `formset_factory`. The code used in this project is mostly taken from django's modelform code.
-
-## Note
-
-**This is pre-alpha software.** Most things are not really tested and although we try to use it wherever posible, you may stumble over weird bugs or your server might explode.
-
-## What works
-
-You should be able to use *mongodbforms* just like django's standard forms. If you can't you have most likely found a bug. [Report it, please.](https://github.com/jschrewe/django-mongodbforms/issues) Thank you.
-
-## Usage
-
-mongodbforms supports forms for normal documents and embedded documents. 
-
-### Normal documents
-
-To use mongodbforms with normal documents replace djangos forms with mongodbform forms.
-
-    from mongodbforms import DocumentForm
-
-    class BlogForm(DocumentForm)
-        ...
-
-### Embedded documents
-
-For embedded documents use `EmbeddedDocumentForm`. The Meta-object of the form has to be provided with an embedded field name. The embedded object is appended to this. The form constructor takes an additional argument: The document the embedded document gets added to.
-
-    # forms.py
-    from mongodbforms import EmbeddedDocumentForm
-    
-    class MessageForm(EmbeddedDocumentForm):
-        class Meta:
-		    document = Message
-		    embedded_field_name = 'messages'
-    
-		    fields = ['subject', 'sender', 'message',]
-
-    # views.py
-    form = MessageForm(parent_document=some_document, ...)
-
-
