Metadata-Version: 2.1
Name: django-easy-report
Version: 0.1.0
Summary: Django app for report generation
Home-page: https://github.com/ehooo/django_easy_report
Author: Victor Torre
Author-email: web.ehooo@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/ehooo/django_easy_report/issues
Description: # Django easy report
        Django App for generate easily reports using [Celery](https://docs.celeryproject.org/en/stable/index.html)
        
        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:
        ```shell
        pip install django-easy-report
        ```
        * Add application on `settings.py`:
        ```python
        # ...
        INSTALLED_APPS = [
        # ...
            'django_easy_report',
        # ...
        ]
        ```
        * Add on `urls.py` the namespace `django_easy_report`:
        ```python
        # ...
        urlpatterns = [
            # ...
            path('reports/', include(('django_easy_report.urls', 'django_easy_report'), namespace='django_easy_report')),
            # ...
        ]
        ```
        * Configure [celery](https://docs.celeryproject.org/en/stable/django/first-steps-with-django.html)
        
        # Howto
        1. Create your code ([see example](./django_easy_report/tests/test_example.py))
        2. Create report Sender on Admin page
        3. Create Report Generator on Admin page
        
        ## API workflow
        See doc as [OpenAPI format](./openapi.yml)
        
        ![work flow](https://raw.githubusercontent.com/ehooo/django_easy_report/main/doc/Django_easy_report-Generic%20flow.png)
        
        ### Examples
        * Notify me when report is done
        
        ![notify me when report is done](https://raw.githubusercontent.com/ehooo/django_easy_report/main/doc/Django_easy_report-Notify%20example.png)
        * Regenerate new report
        
        ![generate new report](https://raw.githubusercontent.com/ehooo/django_easy_report/main/doc/Django_easy_report-Regenerate%20report%20example.png)
        
        ## Test it with Docker
        * Docker-compose
        ```shell
        docker-compose up web -d
        docker-compose exec web bash
        ```
        * Docker
        ```shell
        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
        ```shell
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
