Adding spaghetti to your project

Install some spaghetti:

pip install django-spaghetti-and-meatballs

Add "django_spaghetti" to your INSTALLED_APPS setting like this:

INSTALLED_APPS = [
    ...
    'django_spaghetti',
]

SPAGHETTI_SAUCE = {
    'apps': ['auth', 'polls'],
    'show_fields': False,
    'exclude': {'auth': ['user']},
}

urlpatterns += patterns('',
    url(r'^plate/', include('django_spaghetti.urls')),
)

A sample platter

Below is an example image showing the connections between models from the django-reversion and django-notifications apps and Django’s built-in auth models.

Colored edges illustrate foreign key relations, with arrows pointing from the defining model to the related model, while gray edges illustrate many-to-many relations. Different colors signify the different Django apps, and when relations link between apps the edges are colored with a gradient.

Hovering over a model, gives a pop-up that lists the following information:

• model name

• app label

• The models docstring

• A list of every field, with its field type and its help text (if defined). Unique fields have their name underlined.

This was build with the sauce:

SPAGHETTI_SAUCE = {
    'apps': ['auth', 'notifications', 'reversion'],
    'show_fields': False,
}

A complex live-demo

To see a complex example, where django-spaghetti-and-meatballs really shines, checkout the live version built for the Aristotle Metadata Registry

Testing and developing

I like keeping my development environments isolated in docker. You can too. If you want to install poetry locally, you can skip this bit.

• Build a container with Pythong and Poetry installed - docker build . -t spaghetti

• Run a container for developing docker run -v “$(realpath .)”:/site -w /site -p 8000:8000 -it –rm spaghetti bash

• Install the dependencies - poetry install

• Open a poetry shell - poetry shell

• Run the server - django-admin runserver 0.0.0.0:8000

If you navigate to 127.0.0.1:8000 should should see the demo app.