=====
django_schema
=====
Django Schema is a simple Django app to generate schema of Models .
Installation
```shell
$ pipenv install django_schema
```
Detailed documentation is in the "docs" directory.
Quick start
-----------
1. Add "schema" to your INSTALLED_APPS setting like this::
```python
INSTALLED_APPS = [
...
'django_schema',
]
```
2. Add list of local apps to SCHEMA_APPS setting like this
```python
SCHEMA_APPS = [
'blog',
'users',
'product',
]
```
3. Include the schema URLconf in your project urls.py like this::
```python
from django.urls import include
urlpatterns = [
...
path('schema/', include('django_schema.urls'))
]
```
4. Visit http://127.0.0.1:8000/schema/ to check all the schema styles
5. For testing
```python
MODEL_SCHEMA_TEST = {
'app_name':'blog',
'model':'post'
}
```
## To Do
- Permission
- Handling App versioning for ex 'apps/v1/blog', 'apps/v1/users'
- Add Serializers For all the Django Model Field INTERNAL_TYPES
- Handle more html elements types
- Add docs
- Add Testing
django_schema
=====
Django Schema is a simple Django app to generate schema of Models .
Installation
```shell
$ pipenv install django_schema
```
Detailed documentation is in the "docs" directory.
Quick start
-----------
1. Add "schema" to your INSTALLED_APPS setting like this::
```python
INSTALLED_APPS = [
...
'django_schema',
]
```
2. Add list of local apps to SCHEMA_APPS setting like this
```python
SCHEMA_APPS = [
'blog',
'users',
'product',
]
```
3. Include the schema URLconf in your project urls.py like this::
```python
from django.urls import include
urlpatterns = [
...
path('schema/', include('django_schema.urls'))
]
```
4. Visit http://127.0.0.1:8000/schema/ to check all the schema styles
5. For testing
```python
MODEL_SCHEMA_TEST = {
'app_name':'blog',
'model':'post'
}
```
## To Do
- Permission
- Handling App versioning for ex 'apps/v1/blog', 'apps/v1/users'
- Add Serializers For all the Django Model Field INTERNAL_TYPES
- Handle more html elements types
- Add docs
- Add Testing
1 maintainer
Release files for django-schema 0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django_schema-0.1.tar.gz | 14.0 kB | Details |
Release files / django_schema-0.1.tar.gz
| Download URL | django_schema-0.1.tar.gz |
|---|---|
| Size | 14.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
262c0cf55426f281e5c096e9c06d7f4f99b0e49929927f488dd1943d9cfabc76
|
|
BLAKE2b-256 checksum How to use checksums |
93ffc42fe2ce0a6f08313861fa1f3622f52a2f948cc1c44840acb04a661f1ab5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.1 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.7.0
|
