Django Sage Painless
The django-sage-painless is a valuable package based on Django Web Framework & Django Rest Framework for high-level and rapid web development. The introduced package generates Django applications. After completing many projects, we concluded that any basic project and essential part is its database structure. You can give the database schema in this package and get some parts of the Django application, such as API, models, admin, signals, model cache, setting configuration, mixins, etc. All of these capabilities come with a unit test. So you no longer have to worry about the simple parts of Django, and now you can write your advanced services in Django. The django-sage-painless dramatically speeds up the initial development of your projects. Documentation of this package is available in readthedocs.
However, we intend to make it possible to use it in projects that are in-progress.
We used the name painless instead of the Django code generator because this package allows you to reach your goals with less effort.
- Language: Python > 3.6
- Framework: Django > 3.1
S.A.G.E. team Git Rules Policy is available here:
Before creating Djagno project you must first create virtualenv.
$ python3.9 -m pip install virtualenv $ python3.9 -m virtualenv venv
To activate virtualenvironment in ubuntu:
$ source venv/bin/activate
To deactive vritualenvironment use:
First create a Django project
$ mkdir GeneratorTutorials $ cd GeneratorTutorials $ django-admin startproject kernel .
First install package
$ pip install django-sage-painless
Then add 'sage_painless' to INSTALLED_APPS in settings.py
TIP: You do not need to install the following packages unless you request to automatically generate an API or API documentation.
However, you can add following apps in your INSTALLED_APPS:
INSTALLED_APPS = [ 'sage_painless', 'rest_framework', 'drf_yasg', 'django_seed', ]
To generate a Django app you just need a diagram in JSON format. diagram is a json file that contains information about database tables.
start to generate (it is required for development. you will run tests on this app)
First validate your diagram format. It will raise errors if your diagram format is incorrect.
$ python manage.py validate_diagram --diagram <path to diagram>
Now you can generate code
$ python manage.py generate --diagram <path to diagram>
Here system will ask you what you want to generate for your app.
If you generated api you have to add app urls to urls.py:
urlpatterns = [ path('api/', include('products.api.urls')), ]
- You have to migrate your new models
$ python manage.py makemigrations $ python manage.py migrate
- You can run tests for your app
$ python manage.py test products
- Django run server
$ python manage.py runserver
Rest API documentation is available at
For support Rest API doc add this part to your urls.py
from rest_framework.permissions import AllowAny from drf_yasg.views import get_schema_view from drf_yasg import openapi schema_view = get_schema_view( openapi.Info( title="Rest API Doc", default_version='v1', description="Auto Generated API Docs", license=openapi.License(name="S.A.G.E License"), ), public=True, permission_classes=(AllowAny,), ) urlpatterns = [ path('api/doc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-swagger-ui'), ]
- Rest API documentation is available at
How to Contribute
Run project tests before starting to develop
productsapp is required for running tests
$ python manage.py startapp products
INSTALLED_APPS = [ 'products', ]
you have to generate everything for this app
diagram file is available here: Diagram
$ python manage.py generate --diagram sage_painless/tests/diagrams/product_diagram.json
- run tests
$ python manage.py test sage_painless
|Sepehr Akbarazadeh Maintainer||Mehran Rahmanzadeh Maintainer|
- generate README.md
- db encryption
- video streaming
- improve test generation
- coverage & tox
- deployment questionnaire
- management command
- gunicorn, uwsgi, etc
- nginx configuration
- commit generation
- GitHub repo integration
- CI CD
- multi Database
- security config and check
- package manager support