Django app for report generation
Project description
Django easy report
Django App for generate easily reports using Celery
Implments the following functions:
- Allows permissions by report.
- Allows multi storage systems.
- Allows prevalidation before generate.
- Detect same report params to allows cache it.
- Allows add requeters to a existing report.
- Allows customize send flow inside the report code.
SetUp
- Install package:
pip install django-easy-report
- Add application on
settings.py
:
# ...
INSTALLED_APPS = [
# ...
'django_easy_report',
# ...
]
- Add on
urls.py
the namespacedjango_easy_report
:
# ...
urlpatterns = [
# ...
path('reports/', include(('django_easy_report.urls', 'django_easy_report'), namespace='django_easy_report')),
# ...
]
- Configure celery
Howto
- Create your code (see example)
- Create report Sender on Admin page
- Create Report Generator on Admin page
API workflow
See doc as OpenAPI format
Examples
- Notify me when report is done
- Regenerate new report
Test it with Docker
- Docker-compose
docker-compose up web -d
docker-compose exec web bash
- Docker
docker build . --tag="django_easy_report:latest"
docker run --publish=8000:8000 --name=django_easy_report_web django_easy_report:latest -d
docker exec -ti django_easy_report_web bash
- Run tests locally
docker build . --tag="django_easy_report:py38dj22" --build-arg PY_VERSION=3.8 --build-arg DJANGO_VERSION=2.2
docker run --rm --entrypoint /usr/local/bin/python --name=test_django_easy_report_web django_easy_report:py38dj22 manage.py test
Note that in that case you need rebuild with any change in the code
License
Copyright 2021 Victor Torre
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_easy_report-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 926c81319214ac994a80ded4bcdc76ebbe3de40607b20e60e24f395e88e87518 |
|
MD5 | e16f117e0ef6fec664d36d65eaae4135 |
|
BLAKE2b-256 | 536b0afc7cad8ac9a70cf91a3fee2c480a526ce0a400a68aaa09697aec9d00ef |