Skip to main content

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

Project details


Release history Release notifications | RSS feed

This version

0.1

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 details)

Uploaded Source

File details

Details for the file django_schema-0.1.tar.gz.

File metadata

  • Download URL: django_schema-0.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for django_schema-0.1.tar.gz
Algorithm Hash digest
SHA256 262c0cf55426f281e5c096e9c06d7f4f99b0e49929927f488dd1943d9cfabc76
MD5 ae8b7ab7efeeaa5eb5c9e27359b94c43
BLAKE2b-256 93ffc42fe2ce0a6f08313861fa1f3622f52a2f948cc1c44840acb04a661f1ab5

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