graph-models - Herramienta de visualización del modelo Django

Trabajando con Django me he encontrado con la necesidad de tener claridad del modelo y sus relaciones, sobre todo cuando el proyecto va creciendo.

Había oído hablar de la existencia de una herramienta que me permitiría hacerlo y me decidí a buscarla e implementarla. Les contaré que no me fue sencillo sin conocimiento previo, aunque ahora que lo tengo claro puedo decir no es complicado si uno sabe los pasos. Paso a contarles cuales son.

django-extensions y el comando graph-models

Utilizaremos para esto la librería django-extensions, la cual permite entre otras cosas, generar un gráfico con el modelo y sus relaciones. Dejo el link de la documentación para que puedan darle una buena mirada: https://django-extensions.readthedocs.io/en/latest/

Yendo al grano, estos son los pasos para instalar la librería y sus dependencias.

En una consola de comandos ejecuta lo siguiente:

$ pip install django-extensions

Y a continuación estos comandos para instalar sus dependencias:

$ pip install pygraphviz
$ pip install pydotplus

Ten en cuenta que pygraphviz requerirá ademas, que instales graphviz desde http://www.graphviz.org/ la cual es una librería open source sobre la que se apoya pygraphviz por lo que debes ingresar al link anterior, descargar e instalar la versión que corresponda a tu sistema operativo.

Si posees Ubuntu, éste ultimo proceso es mas que simple, solo ejecuta:

$ sudo apt-get install graphviz

Tendiendo todo lo anterior instalado, podemos proceder a ejecutar en la raíz de nuestro proyecto Django:

$ ./manage.py graph_models -a -o project-models.png

Al finalizar el proceso, se creará un archivo llamado project-models.png conteniendo tanto los modelos como sus relaciones.

El gráfico generado presentará un estilo similar a este conteniendo lo que posean en su proyecto:

Eso es todo. Pruébelo y envíenme sus comentarios al respecto. Saludos!

Escrito por: Leonardo David Gonzalez