Skip to main content

Django app for report generation

Project description

Django easy report

Django App for generate easily reports using Celery

API workflow

See doc as OpenAPI format ![work flow](./doc/Django_easy_report-Generic flow.png)

Examples

  • Notify me when report is done ![notify me when report is done](./doc/Django_easy_report-Notify example.png)
  • Regenerate new report ![generate new report](./doc/Django_easy_report-Regenerate report example.png)

SetUp

  • Add application on settings.py:
# ...
INSTALLED_APPS = [
# ...
    'django_easy_report',
# ...
]
  • Add on urls.py the namespace django_easy_report:
# ...
urlpatterns = [
    # ...
    path('reports/', include(('django_easy_report.urls', 'django_easy_report'), namespace='django_easy_report')),
    # ...
]

Howto

  1. Create your code (see example)
  2. Create report Sender on Admin page
  3. Create Report Generator on Admin page

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

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

django-easy-report-0.0.2.tar.gz (20.8 kB view hashes)

Uploaded Source

Built Distribution

django_easy_report-0.0.2-py3-none-any.whl (28.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page