Bump to 0.1.3

Author: pgleeson

examples/document.md

@@ -0,0 +1,44 @@
+## Document
+A model for documents
+#### Allowed parameters
+<table><tr><td><b>title</b></td><td>str</td><td><i>Document title</i></td></tr>
+
+<tr><td><b>ISBN</b></td><td>int</td><td><i>International Standard Book Number</i></td></tr>
+
+<tr><td><b>id</b></td><td>str</td><td><i>Unique ID of element</i></td></tr>
+
+<tr><td><b>notes</b></td><td>str</td><td><i>Human readable notes</i></td></tr>
+
+
+</table>
+
+#### Allowed children
+<table><tr><td><b>sections</b></td><td><a href="#section">Section</a></td><td><i>The sections of the document</i></td></tr>
+
+
+</table>
+
+## Section
+A model of a section of the document
+#### Allowed parameters
+<table><tr><td><b>id</b></td><td>str</td><td><i>Unique ID of element</i></td></tr>
+
+<tr><td><b>notes</b></td><td>str</td><td><i>Human readable notes</i></td></tr>
+
+
+</table>
+
+#### Allowed children
+<table><tr><td><b>paragraphs</b></td><td><a href="#paragraph">Paragraph</a></td><td><i>The paragraphs</i></td></tr>
+
+
+</table>
+
+## Paragraph
+A model of a paragraph
+#### Allowed parameters
+<table><tr><td><b>contents</b></td><td>str</td><td><i>Paragraph contents</i></td></tr>
+
+
+</table>
+

examples/document.py

@@ -17,7 +17,7 @@ def __init__(self, **kwargs):
 
         super(Document, self).__init__(**kwargs)
 
-        print('Created:: %s'%(self))
+        print("Created:: %s" % (self))
 
 
 class Section(BaseWithId):
@@ -46,7 +46,7 @@ def __init__(self, **kwargs):
 doc.title = "My life in Python"
 
 a = Section(id="Abstract")
-p = Paragraph(contents='Blah blah blah')
+p = Paragraph(contents="Blah blah blah")
 a.paragraphs.append(p)
 doc.sections.append(a)
 doc.sections.append(Section(id="Chapter 1"))
@@ -55,3 +55,8 @@ def __init__(self, **kwargs):
 
 doc.to_json_file("document.json")
 doc.to_yaml_file("document.yaml")
+
+doc_md = doc.generate_documentation(format="markdown")
+
+with open("document.md", "w") as d:
+    d.write(doc_md)

modelspec/BaseTypes.py

@@ -14,7 +14,6 @@ def __init__(self, expr):
         self.expr = expr
 
 
-
 def print_(text, print_it=False):
     """
     Print a message preceded by modelspec, only if print_it=True
@@ -69,15 +68,13 @@ def get_id(self):
     def get_type(self):
         return self.__class__.__name__
 
-
     def add_allowed_child(self, name, description, type_):
 
         if self.allowed_children is None:
             self.allowed_children = collections.OrderedDict([])
 
         self.allowed_children[name] = (description, type_)
 
-
     def add_allowed_field(self, name, description, type_):
         if self.allowed_fields is None:
             self.allowed_fields = collections.OrderedDict([])
@@ -86,11 +83,11 @@ def add_allowed_field(self, name, description, type_):
 
     def __getattr__(self, name):
 
-
         if name == "id" and not "id" in self.allowed_fields:
             return None
 
-        if verbose: print_v(" > Checking the value of attribute %s in: %s..."%(name,'?'))
+        if verbose:
+            print_v(" > Checking the value of attribute %s in: %s..." % (name, "?"))
 
         if name in self.__dict__:
             return self.__dict__[name]
@@ -123,7 +120,6 @@ def __getattr__(self, name):
 
         return None
 
-
     @classmethod
     def _is_evaluable_expression(cls, value):
         if not hasattr(value, "__name__"):
@@ -509,7 +505,6 @@ def __init__(self, **kwargs):
 
         super(BaseWithId, self).__init__(**kwargs)
 
-
     def get_id(self):
         if len(self.fields) == 0:
             return "???"

modelspec/__init__.py

@@ -1,2 +1 @@
-
-__version__ = "0.1.2"
+__version__ = "0.1.3"