Skip to main content

Visualizes a DB schema based on Django models

Project description

django-schema-viewer

GitHub Actions badge PyPI - Version PyPI - Python Version PyPI - Django Version PyPI - License

framework - Django Hatch project Ruff

Buy me a coffee Support me Patreon Liberapay

Visualizes a DB schema based on Django models.

django-schema-viewer demo

Installation

pip install django-schema-viewer

Usage

  1. Install the package

  2. Add schema_viewer to your INSTALLED_APPS settings like this:

INSTALLED_APPS = [
    ...,
    'schema_viewer',
    ...,
]
  1. Add schema_viewer.urls to main urls.py:
from django.urls import path, include

urlpatterns = [
    ...,
    path('schema-viewer/', include('schema_viewer.urls')),
    ...,
]
  1. Run the project
python manange.py runserver
  1. Go to http://127.0.0.1:8000/schema-viewer/

Optional settings

SCHEMA_VIEWER = {
    'apps': [
        'contenttypes',
        'my_app',
    ],
    'exclude': {
        'auth': ['User'],
        'my_app': ['SomeModel'],
    },
}

License

MIT

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_viewer-0.5.3.tar.gz (486.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_schema_viewer-0.5.3-py3-none-any.whl (492.7 kB view details)

Uploaded Python 3

File details

Details for the file django_schema_viewer-0.5.3.tar.gz.

File metadata

  • Download URL: django_schema_viewer-0.5.3.tar.gz
  • Upload date:
  • Size: 486.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for django_schema_viewer-0.5.3.tar.gz
Algorithm Hash digest
SHA256 d5bdaa7cfec0827d1232f1d79f746ea5a7f42bf6abf2359615084acb230b2d1c
MD5 58f633f59042957f5503c0ae74a47ce4
BLAKE2b-256 378055f39f2ec3c50fd2f2db8dd7fbc9cf7ade15cf82347a8496023e2e86bb59

See more details on using hashes here.

File details

Details for the file django_schema_viewer-0.5.3-py3-none-any.whl.

File metadata

File hashes

Hashes for django_schema_viewer-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f6385d74c6e2c5e204fc7b2b8d7d25affe63f9f6b96b03e79e5b094b5012588a
MD5 ef5e097032c2118d884f354e6ebdedd5
BLAKE2b-256 e87e1203dcdce3fd1fbf6f7924961ba5aed4407cddd4074d784806de3f0242f5

See more details on using hashes here.

Supported by

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