For generating a pdf-report with apache-superset charts
Project description
superset-pdf-report
superset-pdf-report is a Python tool for downloading charts from the Apache Superset API or URLs to generate a PDF report via LaTeX and send it via e-mail.
There are two possiblilities for using this tool:
- run it by Celery via supersetconfig.py
- run it via class PDF_report
Installation
Use the package manager pip to install superset-pdf-report.
pip install superset-pdf-report
Configuration of superset-pdf-report
Open config.py in supersetpdfreport and enter the needed information or use the suggested environment variables.
Create your job
Create a <your_job>.json
in supersetpdfreport/jobs
Please refer to the example_job.json
Configuration and start via Celery
Insert in superset_config.py
Celery config:
CELERY_IMPORTS = 'supersetpdfreport.task'
Add task in CELERYBEAT_SCHEDULE
'reports-pdf.scheduler': {
'task':'reports-pdf.scheduler',
'schedule': crontab(minute='*'),
}
You have to restart your Apache Superset application for this changes.
Start via PDF_report()
Create a start.py
from supersetpdfreport.pdf_report import PDF_report
job_name = "<your job>.json"
pdf_report_task = PDF_report()
pdf_report_task.execute(job_name)
Start the Python script
python3 start.py
Usage
- Download the charts you need for the report
- Download the images you need for the report
- Create your LaTeX file in /latex and use the images in latex/images
- Activate the "generate_pdf" in job
- Send it via e-mail or send to nextcloud
Project details
Release history Release notifications | RSS feed
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 superset-pdf-report-0.6.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78b4ba899003934d960691c51d2dd98ece8de8f87a1f413b90fbc8debd928e3b |
|
MD5 | b9b9142cebc2f949330bae00416a355a |
|
BLAKE2b-256 | 4c58badcab85f70741c3844416d39cb4667bbabb45e59a5edfaed1641e858b5c |
Hashes for superset_pdf_report-0.6.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6636b3ff65519072dfdf15c3d31ccc7b2544a0c9cab2af67edd121aa346edf91 |
|
MD5 | 605816153f03c01ea07567b8de203fcd |
|
BLAKE2b-256 | f28935bef7f2e485ef8ea2ab02ea3961e4bfe3da9019ffd5becc9fea8046ff70 |