Skip to main content

An interactive graph of your Django model structure.

Project description

Django Schema Graph

Django-schema-graph makes a colourful diagram out of your Django models. The diagram is interactive, and makes it easy to toggle models and apps on/off at will.

It looks like this:

Feature Screenshot
Models models screenshot
Apps apps screenshot
Both together models and apps screenshot
Graph editor menu screenshot

(Apologies that the images above don't work on PyPI. Check it out on GitHub.)

Installation

Install from PyPI:

pip install django-schema-graph

Add to INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'schema_graph',
    ...
]

Add to your URLs.

from schema_graph.views import Schema
urlpatterns += [
    # On Django 2+:
    path("schema/", Schema.as_view()),
    # Or, on Django < 2:
    url(r"^schema/$", Schema.as_view()),
]

Use

Browse to /schema/ (assuming that's where you put it in your URLs).

Note: DEBUG mode is required, on the assumption that you don't want to leak sensitive information about your website outside of local development.

Support

Tests run on sensible combinations of:

  • Python (3.6-3.10)
  • Django (1.11-4.0)

If you're stuck on old version of Python or Django, you may consider installing old versions. They will probably have fewer features, and there will be no support for them.

The last version to support Python 2.7 and 3.5 was 1.2.0

The last version to support Django 1.8 was 1.2.0

Alternatives

  • django-spaghetti-and-meatballs is great. At the time of writing, it offers a lot more detailed information on the models in the diagram, but doesn't allow them to be turned on/off in the page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-schema-graph-2.0.0.tar.gz (297.4 kB view details)

Uploaded Source

Built Distribution

django_schema_graph-2.0.0-py3-none-any.whl (298.0 kB view details)

Uploaded Python 3

File details

Details for the file django-schema-graph-2.0.0.tar.gz.

File metadata

  • Download URL: django-schema-graph-2.0.0.tar.gz
  • Upload date:
  • Size: 297.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.15.0-1014-azure

File hashes

Hashes for django-schema-graph-2.0.0.tar.gz
Algorithm Hash digest
SHA256 cb1d335e32daadf451123398092493f1f0a7a87d035d769731d6dd05af309c17
MD5 43ffecef8834c83b94640c2af89749ed
BLAKE2b-256 d4c1157e70b49400ad629cfb9ee0b08e45932dc693b6b3e2baca92b7d475de15

See more details on using hashes here.

File details

Details for the file django_schema_graph-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_schema_graph-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9637435b704f335f54e73cede6c9c048f701313d4244d9fe9383fd46728b9e5a
MD5 c5877e6abc5a70b5a2f80b0d87b93a5c
BLAKE2b-256 eaf637b02a4f820f9f05fa6cfab6cc651f53c0cca867f620d54c0ffc3c22d3b6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page