diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-31 03:16:44 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-31 03:16:44 +0000 |
| commit | cbb454da9cefcfdbe5441eec1b213ed0d4dd91a4 (patch) | |
| tree | c9e9b77637cccf68c579c3399dfadabd2c79c1bc | |
| parent | 832f88d2bc25131bd76e9a35358ab868ab4d1c46 (diff) | |
automatic import of python-django-sage-painless
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-django-sage-painless.spec | 879 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 881 insertions, 0 deletions
@@ -0,0 +1 @@ +/django-sage-painless-1.14.3.tar.gz diff --git a/python-django-sage-painless.spec b/python-django-sage-painless.spec new file mode 100644 index 0000000..b9a0f23 --- /dev/null +++ b/python-django-sage-painless.spec @@ -0,0 +1,879 @@ +%global _empty_manifest_terminate_build 0 +Name: python-django-sage-painless +Version: 1.14.3 +Release: 1 +Summary: A handy tool for generating Django-based backend projects without coding. On the other hand, it is a code generator of the Django framework. +License: GNU +URL: https://github.com/sageteam-org/django-sage-painless +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/cc/e3/73ca65755a113e93682d52531398542ade6961bb656812a6f492ac7e1334/django-sage-painless-1.14.3.tar.gz +BuildArch: noarch + + +%description +# Django Sage Painless + +The [django-sage-painless](https://github.com/sageteam-org/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](https://django-sage-painless.readthedocs.io/). + +## Vision + +However, we intend to make it possible to use it in projects that are in-progress. + +## Why Painless + +We used the name painless instead of the Django code generator because this package allows you to reach your goals with less effort. + + + +[](http://sageteam.org) + + + + + + + + + + + +- [Project Detail](#project-detail) +- [Get Started](#getting-started) +- [Usage](#usage) +- [Contribute](#how-to-contribute) +- [Git Rules](#git-rules) + +## Project Detail + +- Language: Python > 3.6 +- Framework: Django > 3.1 + +## Getting Started + +Before creating Djagno project you must first create virtualenv. + +``` shell +$ python3.9 -m pip install virtualenv +$ python3.9 -m virtualenv venv +``` + +To activate virtualenvironment in ubuntu: + +```shell +$ source venv/bin/activate +``` + +To deactive vritualenvironment use: + +``` shell +$ deactivate +``` + +## Start Project + +First create a Django project + +```shell +$ mkdir GeneratorTutorials +$ cd GeneratorTutorials +$ django-admin startproject kernel . +``` + +## Install Generator + +First install package + +```shell +$ 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: + +- rest_framework +- drf_yasg +- django_seed + +```python +INSTALLED_APPS = [ + 'sage_painless', + 'rest_framework', + 'drf_yasg', + 'django_seed', +] +``` + +## Usage + +To generate a Django app you just need a diagram in JSON format. diagram is a json file that contains information about database tables. + +[Diagram examples](sage_painless/docs/diagrams) + +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. + +```shell +$ python manage.py validate_diagram --diagram <path to diagram> +``` + +- Now you can generate code (you need generate diagram json file) + +[Generate diagram sample](tests/diagrams/product_diagram.json) + +```shell +$ python manage.py generate --diagram <path to diagram> +``` + +- You can generate deploy config files (you need a deploy diagram json file) + +[Deploy diagram sample](tests/diagrams/deploy_diagram.json) + +```shell +$ python manage.py deploy --diagram <path to deploy diagram> +``` + +- You can generate doc files (README, etc) + +```shell +$ python manage.py docs --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 main urls.py: + +```python +urlpatterns = [ + path('api/', include('products.api.urls')), +] +``` + +- You have to migrate your new models + +```shell +$ python manage.py makemigrations +$ python manage.py migrate +``` + +- You can run tests for your app + +```shell +$ python manage.py test products +``` + +- Django run server + +```shell +$ python manage.py runserver +``` + +- For support Rest API doc add this part to your urls.py + +```python +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 `localhost:8000/api/doc/` + +## How to Contribute + +Run project tests before starting to develop + +- `products` app is required for running tests + +```shell +$ python manage.py startapp products +``` + +```python +INSTALLED_APPS = [ + 'products', +] +``` + +- you have to generate everything for this app + +- diagram file is available here: [Diagram](tests/diagrams/product_diagram.json) +- download diagram file and generate test app using this commend + +```shell +$ python manage.py generate --diagram tests/diagrams/product_diagram.json +``` + +- run tests + +```shell +$ python manage.py test sage_painless +``` + +## Git Rules + +S.A.G.E. team Git Rules Policy is available here: + +- [S.A.G.E. Git Policy](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) + +## Team +| [<img src="https://github.com/sageteam-org/django-sage-painless/blob/develop/docs/images/sepehr.jpeg?raw=true" width="230px" height="230px" alt="Sepehr Akbarzadeh">](https://github.com/sepehr-akbarzadeh) | [<img src="https://github.com/sageteam-org/django-sage-painless/blob/develop/docs/images/mehran.png?raw=true" width="225px" height="340px" alt="Mehran Rahmanzadeh">](https://github.com/mehran-rahmanzadeh) | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Sepehr Akbarazadeh Maintainer](https://github.com/sepehr-akbarzadeh) | [Mehran Rahmanzadeh Maintainer](https://github.com/mehran-rahmanzadeh) | + +## Version 1 +- [x] generate README.md +- [x] db encryption +- [x] video streaming +- [x] improve test generation +- [x] coverage & tox +- [x] deployment questionnaire +- [x] management command +- [x] docker +- [x] gunicorn, uwsgi, etc +- [x] nginx configuration +- [x] commit generation +- [ ] GitHub repo integration +- [ ] CI CD +- [ ] Database Support (postgres, mysql, sqlite, sql server) +- [ ] security config and check +- [ ] seo +- [ ] graphql +- [x] package manager support + +## Version 2 +- [ ] Django admin generator +- [ ] modular setting +- [ ] mock data generator +- [ ] file field svg support +- [ ] image field enhancement +- [ ] traditional mixins +- [ ] decorator signals +- [ ] logging configuration +- [ ] sentry support +- [ ] monitoring feature (prometheus) +- [ ] track data history +- [ ] stream upload +- [ ] CORS config +- [ ] mongo support +- [ ] Elastic search configuration +- [ ] cache support (+Memcache) +- [ ] error handlers (2xx, 3xx, 4xx, 5xx) +- [ ] django forms support +- [ ] django view support +- [ ] image compression support +- [ ] debug tools support + +%package -n python3-django-sage-painless +Summary: A handy tool for generating Django-based backend projects without coding. On the other hand, it is a code generator of the Django framework. +Provides: python-django-sage-painless +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-django-sage-painless +# Django Sage Painless + +The [django-sage-painless](https://github.com/sageteam-org/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](https://django-sage-painless.readthedocs.io/). + +## Vision + +However, we intend to make it possible to use it in projects that are in-progress. + +## Why Painless + +We used the name painless instead of the Django code generator because this package allows you to reach your goals with less effort. + + + +[](http://sageteam.org) + + + + + + + + + + + +- [Project Detail](#project-detail) +- [Get Started](#getting-started) +- [Usage](#usage) +- [Contribute](#how-to-contribute) +- [Git Rules](#git-rules) + +## Project Detail + +- Language: Python > 3.6 +- Framework: Django > 3.1 + +## Getting Started + +Before creating Djagno project you must first create virtualenv. + +``` shell +$ python3.9 -m pip install virtualenv +$ python3.9 -m virtualenv venv +``` + +To activate virtualenvironment in ubuntu: + +```shell +$ source venv/bin/activate +``` + +To deactive vritualenvironment use: + +``` shell +$ deactivate +``` + +## Start Project + +First create a Django project + +```shell +$ mkdir GeneratorTutorials +$ cd GeneratorTutorials +$ django-admin startproject kernel . +``` + +## Install Generator + +First install package + +```shell +$ 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: + +- rest_framework +- drf_yasg +- django_seed + +```python +INSTALLED_APPS = [ + 'sage_painless', + 'rest_framework', + 'drf_yasg', + 'django_seed', +] +``` + +## Usage + +To generate a Django app you just need a diagram in JSON format. diagram is a json file that contains information about database tables. + +[Diagram examples](sage_painless/docs/diagrams) + +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. + +```shell +$ python manage.py validate_diagram --diagram <path to diagram> +``` + +- Now you can generate code (you need generate diagram json file) + +[Generate diagram sample](tests/diagrams/product_diagram.json) + +```shell +$ python manage.py generate --diagram <path to diagram> +``` + +- You can generate deploy config files (you need a deploy diagram json file) + +[Deploy diagram sample](tests/diagrams/deploy_diagram.json) + +```shell +$ python manage.py deploy --diagram <path to deploy diagram> +``` + +- You can generate doc files (README, etc) + +```shell +$ python manage.py docs --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 main urls.py: + +```python +urlpatterns = [ + path('api/', include('products.api.urls')), +] +``` + +- You have to migrate your new models + +```shell +$ python manage.py makemigrations +$ python manage.py migrate +``` + +- You can run tests for your app + +```shell +$ python manage.py test products +``` + +- Django run server + +```shell +$ python manage.py runserver +``` + +- For support Rest API doc add this part to your urls.py + +```python +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 `localhost:8000/api/doc/` + +## How to Contribute + +Run project tests before starting to develop + +- `products` app is required for running tests + +```shell +$ python manage.py startapp products +``` + +```python +INSTALLED_APPS = [ + 'products', +] +``` + +- you have to generate everything for this app + +- diagram file is available here: [Diagram](tests/diagrams/product_diagram.json) +- download diagram file and generate test app using this commend + +```shell +$ python manage.py generate --diagram tests/diagrams/product_diagram.json +``` + +- run tests + +```shell +$ python manage.py test sage_painless +``` + +## Git Rules + +S.A.G.E. team Git Rules Policy is available here: + +- [S.A.G.E. Git Policy](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) + +## Team +| [<img src="https://github.com/sageteam-org/django-sage-painless/blob/develop/docs/images/sepehr.jpeg?raw=true" width="230px" height="230px" alt="Sepehr Akbarzadeh">](https://github.com/sepehr-akbarzadeh) | [<img src="https://github.com/sageteam-org/django-sage-painless/blob/develop/docs/images/mehran.png?raw=true" width="225px" height="340px" alt="Mehran Rahmanzadeh">](https://github.com/mehran-rahmanzadeh) | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Sepehr Akbarazadeh Maintainer](https://github.com/sepehr-akbarzadeh) | [Mehran Rahmanzadeh Maintainer](https://github.com/mehran-rahmanzadeh) | + +## Version 1 +- [x] generate README.md +- [x] db encryption +- [x] video streaming +- [x] improve test generation +- [x] coverage & tox +- [x] deployment questionnaire +- [x] management command +- [x] docker +- [x] gunicorn, uwsgi, etc +- [x] nginx configuration +- [x] commit generation +- [ ] GitHub repo integration +- [ ] CI CD +- [ ] Database Support (postgres, mysql, sqlite, sql server) +- [ ] security config and check +- [ ] seo +- [ ] graphql +- [x] package manager support + +## Version 2 +- [ ] Django admin generator +- [ ] modular setting +- [ ] mock data generator +- [ ] file field svg support +- [ ] image field enhancement +- [ ] traditional mixins +- [ ] decorator signals +- [ ] logging configuration +- [ ] sentry support +- [ ] monitoring feature (prometheus) +- [ ] track data history +- [ ] stream upload +- [ ] CORS config +- [ ] mongo support +- [ ] Elastic search configuration +- [ ] cache support (+Memcache) +- [ ] error handlers (2xx, 3xx, 4xx, 5xx) +- [ ] django forms support +- [ ] django view support +- [ ] image compression support +- [ ] debug tools support + +%package help +Summary: Development documents and examples for django-sage-painless +Provides: python3-django-sage-painless-doc +%description help +# Django Sage Painless + +The [django-sage-painless](https://github.com/sageteam-org/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](https://django-sage-painless.readthedocs.io/). + +## Vision + +However, we intend to make it possible to use it in projects that are in-progress. + +## Why Painless + +We used the name painless instead of the Django code generator because this package allows you to reach your goals with less effort. + + + +[](http://sageteam.org) + + + + + + + + + + + +- [Project Detail](#project-detail) +- [Get Started](#getting-started) +- [Usage](#usage) +- [Contribute](#how-to-contribute) +- [Git Rules](#git-rules) + +## Project Detail + +- Language: Python > 3.6 +- Framework: Django > 3.1 + +## Getting Started + +Before creating Djagno project you must first create virtualenv. + +``` shell +$ python3.9 -m pip install virtualenv +$ python3.9 -m virtualenv venv +``` + +To activate virtualenvironment in ubuntu: + +```shell +$ source venv/bin/activate +``` + +To deactive vritualenvironment use: + +``` shell +$ deactivate +``` + +## Start Project + +First create a Django project + +```shell +$ mkdir GeneratorTutorials +$ cd GeneratorTutorials +$ django-admin startproject kernel . +``` + +## Install Generator + +First install package + +```shell +$ 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: + +- rest_framework +- drf_yasg +- django_seed + +```python +INSTALLED_APPS = [ + 'sage_painless', + 'rest_framework', + 'drf_yasg', + 'django_seed', +] +``` + +## Usage + +To generate a Django app you just need a diagram in JSON format. diagram is a json file that contains information about database tables. + +[Diagram examples](sage_painless/docs/diagrams) + +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. + +```shell +$ python manage.py validate_diagram --diagram <path to diagram> +``` + +- Now you can generate code (you need generate diagram json file) + +[Generate diagram sample](tests/diagrams/product_diagram.json) + +```shell +$ python manage.py generate --diagram <path to diagram> +``` + +- You can generate deploy config files (you need a deploy diagram json file) + +[Deploy diagram sample](tests/diagrams/deploy_diagram.json) + +```shell +$ python manage.py deploy --diagram <path to deploy diagram> +``` + +- You can generate doc files (README, etc) + +```shell +$ python manage.py docs --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 main urls.py: + +```python +urlpatterns = [ + path('api/', include('products.api.urls')), +] +``` + +- You have to migrate your new models + +```shell +$ python manage.py makemigrations +$ python manage.py migrate +``` + +- You can run tests for your app + +```shell +$ python manage.py test products +``` + +- Django run server + +```shell +$ python manage.py runserver +``` + +- For support Rest API doc add this part to your urls.py + +```python +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 `localhost:8000/api/doc/` + +## How to Contribute + +Run project tests before starting to develop + +- `products` app is required for running tests + +```shell +$ python manage.py startapp products +``` + +```python +INSTALLED_APPS = [ + 'products', +] +``` + +- you have to generate everything for this app + +- diagram file is available here: [Diagram](tests/diagrams/product_diagram.json) +- download diagram file and generate test app using this commend + +```shell +$ python manage.py generate --diagram tests/diagrams/product_diagram.json +``` + +- run tests + +```shell +$ python manage.py test sage_painless +``` + +## Git Rules + +S.A.G.E. team Git Rules Policy is available here: + +- [S.A.G.E. Git Policy](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) + +## Team +| [<img src="https://github.com/sageteam-org/django-sage-painless/blob/develop/docs/images/sepehr.jpeg?raw=true" width="230px" height="230px" alt="Sepehr Akbarzadeh">](https://github.com/sepehr-akbarzadeh) | [<img src="https://github.com/sageteam-org/django-sage-painless/blob/develop/docs/images/mehran.png?raw=true" width="225px" height="340px" alt="Mehran Rahmanzadeh">](https://github.com/mehran-rahmanzadeh) | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Sepehr Akbarazadeh Maintainer](https://github.com/sepehr-akbarzadeh) | [Mehran Rahmanzadeh Maintainer](https://github.com/mehran-rahmanzadeh) | + +## Version 1 +- [x] generate README.md +- [x] db encryption +- [x] video streaming +- [x] improve test generation +- [x] coverage & tox +- [x] deployment questionnaire +- [x] management command +- [x] docker +- [x] gunicorn, uwsgi, etc +- [x] nginx configuration +- [x] commit generation +- [ ] GitHub repo integration +- [ ] CI CD +- [ ] Database Support (postgres, mysql, sqlite, sql server) +- [ ] security config and check +- [ ] seo +- [ ] graphql +- [x] package manager support + +## Version 2 +- [ ] Django admin generator +- [ ] modular setting +- [ ] mock data generator +- [ ] file field svg support +- [ ] image field enhancement +- [ ] traditional mixins +- [ ] decorator signals +- [ ] logging configuration +- [ ] sentry support +- [ ] monitoring feature (prometheus) +- [ ] track data history +- [ ] stream upload +- [ ] CORS config +- [ ] mongo support +- [ ] Elastic search configuration +- [ ] cache support (+Memcache) +- [ ] error handlers (2xx, 3xx, 4xx, 5xx) +- [ ] django forms support +- [ ] django view support +- [ ] image compression support +- [ ] debug tools support + +%prep +%autosetup -n django-sage-painless-1.14.3 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-django-sage-painless -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 1.14.3-1 +- Package Spec generated @@ -0,0 +1 @@ +65782046b1a4fe6b69c71d2b7748e146 django-sage-painless-1.14.3.tar.gz |