1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
|
Graph models
============
:synopsis: Renders a graphical overview of your project or specified apps.
Creates a GraphViz_ dot file for the specified app names. You can pass
multiple app names and they will all be combined into a single model. Output
is usually directed to a dot file.
With the latest revisions it's also possible to specify an output file if
pygraphviz_ is installed and render directly to an image or other supported
filetype.
Example Usage
-------------
With *django-command-extensions* installed you can create a dot-file or an
image by using the *graph_models* command. Like used in the following examples::
# Create a dot file
$ ./manage.py graph_models -a > my_project.dot
::
# Create a PNG image file called my_project_visualized.png with application grouping
$ ./manage.py graph_models -a -g -o my_project_visualized.png
::
# Create a dot file for only the 'foo' and 'bar' applications of your project
$ ./manage.py graph_models foo bar > my_project.dot
Example Rendered Graphics
-------------------------
The following graphs are from the PyCon-Tech_ project. PyCon-Tech is a
conference management framework based on Django framework.
Pycon-Tech Project
------------------
http://ido.nl.eu.org/static/images/pycon_no_grouping.png
Pycon-Tech Project Overview With Grouping
-----------------------------------------
http://ido.nl.eu.org/static/images/pycon_grouping.png
.. _GraphViz: http://www.graphviz.org/
.. _pygraphviz: https://networkx.lanl.gov/wiki/pygraphviz
.. _PyCon-Tech: https://pycon.coderanger.net/
|