A simple Django app to generate form schema for django models related to django apps
Project description
=====
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
Project details
Release history Release notifications | RSS feed
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-0.1.tar.gz
(14.0 kB
view hashes)