Update dev docs

README.md

@@ -52,6 +52,10 @@ CTX.firebase_app
 
 ```python
 
+from flask_boiler.factory import ClsFactory
+from flask_boiler import schema, fields 
+
+
 # Creates a schema for serializing and deserializing to firestore database
 class TestObjectSchema(schema.Schema):
 
@@ -63,23 +67,19 @@ class TestObjectSchema(schema.Schema):
     int_b = fields.Raw(load_from="intB", dump_to="intB")
 
 
-# Declares the object 
-class TestObject(PrimaryObject):
-
-    _schema_cls = TestObjectSchema
-
-    def __init__(self, doc_id=None):
-        super().__init__(doc_id=doc_id)
-
-        # Initializes default values of your instance variables 
-        self.int_a = 0
-        self.int_b = 0
+# Declares the object
+TestObject = ClsFactory.create(
+    name="TestObject",
+    schema=TestObjectSchema,
+    # Either MyDomainModelBase (specify cls._collection_id)
+    #  or SubclassOfViewModel 
+    # TODO: ADD MORE DOCS 
+    base=PrimaryObject  
+)
 
 # Creates an object with default values with reference: "TestObject/testObjId1" 
 #   (but not saved to database)
 obj = TestObject.create(doc_id="testObjId1")
-assert obj.doc_id == "testObjId1"
-assert obj.collection_name == "TestObject"
 
 # Assigns value to the newly created object 
 obj.int_a = 1

__init__.py

@@ -1,5 +1,6 @@
 from src import config, context, auth, fields, schema, serializable, \
-    firestore_object, domain_model, view_model, view
+    firestore_object, domain_model, view_model, view, factory
 
 __all__ = ["config", "context", "auth", "fields", "schema", "serializable",
-           "firestore_object", "domain_model", "view_model", "view"]
+           "firestore_object", "domain_model", "view_model", "view",
+           "factory"]

examples/view_example.py

@@ -18,6 +18,11 @@
 from src.context import Context as CTX
 
 if __name__ == "__main__":
+    """
+    Go to http://127.0.0.1:5000/apidocs/ for the auto-generated 
+        documentations. 
+    """
+
     config = Config(
         app_name="gravitate-dive-testing",
         debug=True,
@@ -44,15 +49,6 @@ class Palette(Schema):
 
     description = "A list of colors (may be filtered by palette)"
 
-    # class PaletteView(GenericView):
-
-    # def __new__(cls, *args, **kwargs):
-    #     instance = super().__new__(cls,
-    #                                view_model_cls=PaletteViewModel,
-    #                                description="A list of colors (may be filtered by palette)"
-    #                                )
-    #     return instance
-
     # Create palette document in firestore
     vm = PaletteViewModel.create(
         CTX.db.collection("palettes").document("palette_id_a")

quickstart.md

@@ -133,16 +133,15 @@ default value.
 ```python
 
 # Declares the object 
-class TestObject(DomainModel):
-
-    _schema_cls = TestObjectSchema
-
-    def __init__(self, doc_id=None):
-        super().__init__(doc_id=doc_id)
-
-        # Initializes default values of your instance variables 
-        self.int_a = 0
-        self.int_b = 0
+# Declares the object
+TestObject = ClsFactory.create(
+    name="TestObject",
+    schema=TestObjectSchema,
+    # Either MyDomainModelBase (specify cls._collection_id)
+    #  or SubclassOfViewModel 
+    # TODO: ADD MORE DOCS 
+    base=PrimaryObject  
+)
 
 ```
 
@@ -152,8 +151,6 @@ Now, you can create the object and assign values to it
 # Creates an object with default values with reference: "TestObject/testObjId1" 
 #   (but not saved to database)
 obj = TestObject.create(doc_id="testObjId1")
-assert obj.doc_id == "testObjId1"
-assert obj.collection_name == "TestObject"
 
 # Assigns value to the newly created object 
 obj.int_a = 1

src/__init__.py

@@ -1,3 +1,3 @@
 # from src.context import Context as CTX
 from . import config, context, auth, fields, schema, serializable, \
-    firestore_object, domain_model, view_model
+    firestore_object, domain_model, view_model, factory

src/factory.py

@@ -0,0 +1,4 @@
+from .firestore_object import FirestoreObjectClsFactory
+
+
+ClsFactory = FirestoreObjectClsFactory