📊 Redash Reports 📈

This project generates .XLSX or .PDF reports from CSV data obtained from Redash queries. The report is then emailed using SendGrid based on a predefined schedule. The queries in Redash are refreshed before fetching the CSV to ensure that the report contains the most up-to-date information.

Table of Contents

• ✅ Requirements
• 🛠️ Configuration
  • Modes Explained
• 🧑‍💻 Usage
• 🐳 Running with Docker
• 🌐 Community
  • Contributing 👥
  • Reporting Bugs 🐛
• 📄 License

✅ Requirements

• Python 3
• Pandas
• OpenPyXL
• Requests
• Schedule
• SendGrid
• Redash

You can install the required Python packages with pip:

pip install -r requirements.txt

🛠️ Configuration

You can configure several aspects of the application through environment variables or the settings.py file. This includes the Redash base URL, API key, query IDs, report titles, logo URL, email settings, and the report generation schedule. Ensure that the API key has the necessary permissions to refresh the queries and access the results.

Additionally, you can set the report mode (XLSX, XLSX-MULTI, PDF, PDF-MULTI) through command-line arguments or the settings.py file. The schedule should be specified in cron format in the settings.py file.

Modes Explained ℹ️

In this application, the --mode argument allows you to select how reports are generated and sent. Below are the available modes:

• xlsx: This mode generates a single Excel (.xlsx) file containing sheets for each query result. The file is then sent as an email attachment.
• xlsx-multi: This mode generates individual Excel (.xlsx) files for each query result and sends them all as separate attachments in a single email.
• pdf: This mode generates a single PDF file containing pages for each query result. The file is then sent as an email attachment.
• pdf-multi: This mode generates individual PDF files for each query result and sends them all as separate attachments in a single email.

When using modes with multiple attachments (xlsx-multi, pdf-multi), each attachment is named according to the title of the respective query result and includes the time period of the report. In contrast, modes generating single files (xlsx, pdf) create a unified file, where the different sections or sheets are named after the corresponding query titles.

🧑‍💻 Usage

Run the main script with Python:

python main.py --mode [xlsx|xlsx-multi|pdf|pdf-multi] --now

• --mode: Sets the report mode to use (XLSX, XLSX-MULTI, PDF, PDF-MULTI).
• --now: Run the report immediately, bypassing the schedule.

Examples

Run the script immediately, generating a PDF report with multiple attachments:

python main.py --mode pdf-multi --now

The script will run indefinitely in the absence of the --now argument, generating and emailing reports according to the schedule specified in the settings.py.

🐳 Running with Docker

To run the application using Docker, first, pull the Docker image:

docker pull ghcr.io/rahb-realtors-association/redash-report:latest

Set environment variables as needed and run with the following command:

docker run ghcr.io/rahb-realtors-association/redash-report:latest --mode [xlsx|xlsx-multi|pdf|pdf-multi] --now

Alternatively, you can use a settings.py file to configure your environment. Download the settings.example.py, save it as settings.py, modify as needed, and run with the following command:

docker run -v /path/to/your/settings.py:/app/settings.py ghcr.io/rahb-realtors-association/redash-report:latest --mode [xlsx|xlsx-multi|pdf|pdf-multi] --now

🌐 Community

Contributing 👥

Contributions, whether in the form of features, code improvements, or bug reports, are always welcome! Please refer to the contributing guidelines and the code of conduct.

Reporting Bugs 🐛

Found a bug? Open an issue detailing the bug and how it can be reproduced. Please include system information, logs, and any other information that could be helpful in fixing the bug.

📄 License

This project is open source under the MIT license. See the LICENSE file for more info. 📜