Add YAML format.

.travis.yml

@@ -70,6 +70,16 @@ matrix:
      env: TOXENV=py36-django111
    - python: 3.6
      env: TOXENV=py36-django20
+   - python: 3.6
+     env: TOXENV=py36-django21
+   - python: 3.6
+     env: TOXENV=py36-django22
+   - python: 3.7
+     env: TOXENV=py37-django20
+   - python: 3.7
+     env: TOXENV=py37-django21
+   - python: 3.7
+     env: TOXENV=py37-django22
    - python: 3.6
      env: TOXENV=flake8
 

modelsdoc/__init__.py

@@ -8,4 +8,4 @@
 """
 from __future__ import division, print_function, absolute_import, unicode_literals  # NOQA
 
-__version__ = '0.1.9'
+__version__ = '0.1.10'

modelsdoc/templates/modelsdoc/models.yaml

@@ -0,0 +1,4 @@
+{% load modelsdoc_tags %}
+{% autoescape off %}
+{{ models|yamldump }}
+{% endautoescape %}

modelsdoc/templatetags/modelsdoc_tags.py

@@ -8,8 +8,15 @@
 """
 from __future__ import division, print_function, absolute_import, unicode_literals  # NOQA
 
+import django
+from django.db.models.fields import NOT_PROVIDED
+from django.db import router
 from django.template import Library, Node
 
+import yaml
+
+from modelsdoc.utils import get_parent_model_attr, get_related_field
+
 register = Library()
 
 
@@ -62,3 +69,59 @@ def get_attr(obj, attr):
 @register.filter
 def str_repeat(times, string):
     return string * times
+
+
+@register.filter
+def yamldump(models):
+    result = {}
+
+    for model in models:
+        dbname = router.db_for_read(model)
+
+        table = {
+            "name": model._model._meta.db_table,
+            "logical_name": model.display_name,
+            "comment": model.doc,
+            "columns": [],
+        }
+        for field in model.fields:
+
+            fk_table = None
+            related = get_related_field(field, django.VERSION)
+            if related:
+                # TODO change table to column
+                fk = get_parent_model_attr(related, django.VERSION)
+                fk_table = fk._meta.db_table
+
+            default_value = None
+            if field.default != NOT_PROVIDED:
+                default_value = field.default
+                if callable(default_value):
+                    default_value = (default_value.__module__
+                                     + "." + default_value.__name__)
+
+            column = {
+                "name": field.name,
+                "verbose_name": str(field.verbose_name),
+                "data_type": field.db_type,
+                "is_primary": field.primary_key or False,
+                "is_unique": field.unique or False,
+                "is_index": field.db_index or False,
+                "not_null": not field.null,
+                "foreignkey": fk_table,
+                "comment": field.comment,
+                "default": default_value,
+            }
+            table["columns"].append(column)
+
+        if dbname not in result:
+            result[dbname] = dict(
+                name=dbname,
+                logical_name=dbname,
+                comment="",
+                tables=[]
+            )
+
+        result[dbname]["tables"].append(table)
+
+    return yaml.dump(result, allow_unicode=True, default_flow_style=False)

setup.py

@@ -75,7 +75,8 @@ def run(self):
 
 install_requires = [
     'Django',
-    'Sphinx'
+    'Sphinx',
+    'PyYAML',
 ]
 
 tests_require = [

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = flake8,py{27,py,33,34,35,36}-django{15,16,17,18,19,110,111,20}
+envlist = flake8,py{27,py,33,34,35,36,37}-django{15,16,17,18,19,110,111,20,21,22}
 
 [testenv]
 deps = 
@@ -14,6 +14,8 @@ deps =
     django110: Django>=1.10,<1.11
     django111: Django>=1.11,<1.12
     django20: Django>=2.0,<2.1
+    django21: Django>=2.1,<2.2
+    django22: Django>=2.2,<2.3
 commands =
     coverage run --source modelsdoc setup.py test
     coverage report -m