# django-schema-viewer
[](https://github.com/pikhovkin/django-schema-viewer/actions)
[](https://pypi.org/project/django-schema-viewer)
[](https://pypi.org/project/django-schema-viewer)
[](https://pypi.org/project/django-schema-viewer)
[](./LICENSE)
[](https://www.djangoproject.com/)
[](https://github.com/pypa/hatch)
[](https://github.com/astral-sh/ruff)
[](https://www.buymeacoffee.com/pikhovkin)
[](https://ko-fi.com/pikhovkin)
[](https://patreon.com/pikhovkin)
[](https://liberapay.com/pikhovkin)
Visualizes a DB schema based on Django models.
[](https://django-schema-viewer.demox.dev)
### Installation
```console
pip install django-schema-viewer
```
### Usage
1. Install the package
2. Add `schema_viewer` to your `INSTALLED_APPS` settings like this:
```python
INSTALLED_APPS = [
...,
'schema_viewer',
...,
]
```
3. Add `schema_viewer.urls` to main `urls.py`:
```python
from django.urls import path, include
urlpatterns = [
...,
path('schema-viewer/', include('schema_viewer.urls')),
...,
]
```
4. Run the project
```console
python manange.py runserver
```
5. Go to http://127.0.0.1:8000/schema-viewer/
### Optional settings
```python
SCHEMA_VIEWER = {
'apps': [
'contenttypes',
'my_app',
],
'exclude': {
'auth': ['User'],
'my_app': ['SomeModel'],
},
}
```
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "django-schema-viewer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "database-gui, database-schema, django, django-models, django-schema, django-schema-graph, entity-relationship-diagram, er-diagram, erd, json-table-schema, schema, schema-diagram, schema-graph, schema-viewer, viewer",
"author": null,
"author_email": "Sergei Pikhovkin <s@pikhovkin.ru>",
"download_url": "https://files.pythonhosted.org/packages/a2/11/ab9c6b0105d55b9a8197b9795d77fec72d1ec065c2cb479410c6ca1f7daf/django_schema_viewer-0.5.2.tar.gz",
"platform": null,
"description": "# django-schema-viewer\n\n[](https://github.com/pikhovkin/django-schema-viewer/actions)\n\n[](https://pypi.org/project/django-schema-viewer)\n[](https://pypi.org/project/django-schema-viewer)\n[](https://pypi.org/project/django-schema-viewer)\n[](./LICENSE)\n\n[](https://www.djangoproject.com/)\n[](https://github.com/pypa/hatch)\n[](https://github.com/astral-sh/ruff)\n\n[](https://www.buymeacoffee.com/pikhovkin)\n[](https://ko-fi.com/pikhovkin)\n[](https://patreon.com/pikhovkin)\n[](https://liberapay.com/pikhovkin)\n\nVisualizes a DB schema based on Django models.\n\n[![django-schema-viewer demo](docs/screenview.png \"Click to see demo\")](https://django-schema-viewer.demox.dev)\n\n### Installation\n\n```console\npip install django-schema-viewer\n```\n\n### Usage\n\n1. Install the package\n\n2. Add `schema_viewer` to your `INSTALLED_APPS` settings like this:\n\n```python\nINSTALLED_APPS = [\n ...,\n 'schema_viewer',\n ...,\n]\n```\n\n3. Add `schema_viewer.urls` to main `urls.py`:\n\n```python\nfrom django.urls import path, include\n\nurlpatterns = [\n ...,\n path('schema-viewer/', include('schema_viewer.urls')),\n ...,\n]\n```\n\n4. Run the project\n\n```console\npython manange.py runserver\n```\n\n5. Go to http://127.0.0.1:8000/schema-viewer/\n\n### Optional settings\n\n```python\nSCHEMA_VIEWER = {\n 'apps': [\n 'contenttypes',\n 'my_app',\n ],\n 'exclude': {\n 'auth': ['User'],\n 'my_app': ['SomeModel'],\n },\n}\n```\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": null,
"summary": "Visualizes a DB schema based on Django models",
"version": "0.5.2",
"project_urls": {
"Documentation": "https://github.com/pikhovkin/django-schema-viewer#readme",
"Issues": "https://github.com/pikhovkin/django-schema-viewer/issues",
"Source": "https://github.com/pikhovkin/django-schema-viewer"
},
"split_keywords": [
"database-gui",
" database-schema",
" django",
" django-models",
" django-schema",
" django-schema-graph",
" entity-relationship-diagram",
" er-diagram",
" erd",
" json-table-schema",
" schema",
" schema-diagram",
" schema-graph",
" schema-viewer",
" viewer"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aa1af2dc4b54b18da7fd8dec7149c86f484581addd010f65f7a40bf16addbf39",
"md5": "30ed262ff94062e60929adb4c5746da3",
"sha256": "d799f52194cb906add990a1f178d92b0acfcb0a2e54c022843784e06fb12d75b"
},
"downloads": -1,
"filename": "django_schema_viewer-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30ed262ff94062e60929adb4c5746da3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 492672,
"upload_time": "2025-01-11T23:55:40",
"upload_time_iso_8601": "2025-01-11T23:55:40.496140Z",
"url": "https://files.pythonhosted.org/packages/aa/1a/f2dc4b54b18da7fd8dec7149c86f484581addd010f65f7a40bf16addbf39/django_schema_viewer-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a211ab9c6b0105d55b9a8197b9795d77fec72d1ec065c2cb479410c6ca1f7daf",
"md5": "4d8affb29b9972a582ebbb58bf078ec4",
"sha256": "4c9316a3831e6015270b432404f1589b6b711b13ebc6d797b1fce82d1fa7281e"
},
"downloads": -1,
"filename": "django_schema_viewer-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "4d8affb29b9972a582ebbb58bf078ec4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 486063,
"upload_time": "2025-01-11T23:55:38",
"upload_time_iso_8601": "2025-01-11T23:55:38.135712Z",
"url": "https://files.pythonhosted.org/packages/a2/11/ab9c6b0105d55b9a8197b9795d77fec72d1ec065c2cb479410c6ca1f7daf/django_schema_viewer-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 23:55:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pikhovkin",
"github_project": "django-schema-viewer#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-schema-viewer"
}
JSON
