它是一个辣肉丸,提供新鲜的热实体关系图直接从你的django模型。
django-spaghetti-and-meatballs的Python项目详细描述
它是一个辣肉丸,提供新鲜的热实体关系图直接从你的django模型。
在项目中添加意大利面
安装一些意大利面:
pip install django-spaghetti-and-meatballs
将"django_spaghetti"添加到INSTALLED_APPS设置中,如下所示:
INSTALLED_APPS = [ ... 'django_spaghetti', ]
配置酱汁
django-spaghetti-and-meatballs接受在^{tt4}中设置的一些选项$ 来自项目settings.py文件的变量,使其变得更辣:
SPAGHETTI_SAUCE = { 'apps':['auth','polls'], 'show_fields':False, 'exclude':{'auth':['user']} }
在上述字典中,使用以下设置:
- apps是要在图表中显示的应用程序列表。如果它的不在这里,它的将不会被看到。
- show_fields是一个布尔值,它声明字段名是应该显示在图形中,还是只显示在“无论如何”。对于小图,您可以将其设置为true来显示字段,但当您获得更多模型时,它会变得更加混乱。
- exclude是一个字典,其中每个键都是一个app_label,该键的项是要隐藏在图中的模型名。
如果没有按预期工作,请确保应用程序标签和模型名都是小写。
在url文件中提供您的车牌
配置好酱汁后,一定要在urls.py里端上一盘意大利面,就像这样:
urlpatterns += patterns('', url(r'^plate/', include('django_spaghetti.urls')), )
样品盘
下面是一个示例图像,显示来自 django-reversion和 django-notifications 应用程序和django的内置auth模型。
彩色边说明外键关系,箭头指向 模型与相关模型,而灰色边缘说明了多对多的关系。 不同的颜色表示不同的django应用程序,以及 应用程序边缘用渐变色着色。
将鼠标悬停在模型上,会出现一个弹出窗口,其中列出以下信息:
- 型号名称
- 应用程序标签
- 模型文档字符串
- 每个字段及其字段类型和帮助文本(如果已定义)的列表。唯一字段的名称有下划线。
这是用沙司做的:
SPAGHETTI_SAUCE = { 'apps':['auth','notifications','reversion'], 'show_fields':False, }
复杂的现场演示
要查看一个复杂的示例,其中django-spaghetti-and-meatballs非常出色, 签出为Aristotle Metadata Registry生成的实时版本