# 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, 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/f8/ff/defd4519506f5504187ebaac9607bbc1ba8bf882e3f26b234f712b6a5acc/django_schema_viewer-0.4.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": "MIT",
"summary": null,
"version": "0.4.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",
" entity-relationship-diagram",
" er-diagram",
" erd",
" json-table-schema",
" schema",
" schema-diagram",
" schema-graph",
" schema-viewer",
" viewer"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "91995e735af825127ffcd4b545fa4361625ca0bd2fad498c0642b2ea873d872a",
"md5": "4acaaac59069f6a6d3609e996917f3a1",
"sha256": "ec0ebe8d9bf9b23feb79a6fec193657fd16e130d9096b8a8634d3e7fcf223401"
},
"downloads": -1,
"filename": "django_schema_viewer-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4acaaac59069f6a6d3609e996917f3a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 492486,
"upload_time": "2024-12-01T19:51:54",
"upload_time_iso_8601": "2024-12-01T19:51:54.330945Z",
"url": "https://files.pythonhosted.org/packages/91/99/5e735af825127ffcd4b545fa4361625ca0bd2fad498c0642b2ea873d872a/django_schema_viewer-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f8ffdefd4519506f5504187ebaac9607bbc1ba8bf882e3f26b234f712b6a5acc",
"md5": "325c4fbd61548fe29686fe9e9aee692e",
"sha256": "125be8f2d1d283ee7abf760f1fee73c2b9c7fb53c3d85f0222e89a3b48d4a919"
},
"downloads": -1,
"filename": "django_schema_viewer-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "325c4fbd61548fe29686fe9e9aee692e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 485919,
"upload_time": "2024-12-01T19:51:52",
"upload_time_iso_8601": "2024-12-01T19:51:52.500024Z",
"url": "https://files.pythonhosted.org/packages/f8/ff/defd4519506f5504187ebaac9607bbc1ba8bf882e3f26b234f712b6a5acc/django_schema_viewer-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 19:51:52",
"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
