Isaak/cuori
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
12 Commits 1 Branch 0 Tags 60 KiB
HTML 72.9%
Python 27.1%
2236de57ce
Go to file
Isaak 2236de57ce
🔧✉️ Refactor Invoice Emailing Utility 
- 🌐 Enhanced web interface for invoice emailing config management with GET/POST at '/data'.
- 📝 Refactored Flask app to specialize as an invoice emailing utility.
- 🔍 Improved read_yaml() to return data and error messages.
- 📤 Enhanced write_yaml() for better YAML file handling.
- 🛠️ Updated handle_data() to efficiently handle '/data' route with GET/POST methods.

Note: Excluded changes to imports and requires.
2023-12-23 00:12:43 +01:00
.gitignore Initial commit 2023-12-22 00:32:45 +01:00
index.html 🛠️✨ Refactor tab navigation & add listeners in index.html using element IDs. 2023-12-22 23:44:57 +01:00
LICENSE.md Initial Commit 2023-12-22 00:49:32 +01:00
main.py 🔧✉️ Refactor Invoice Emailing Utility 2023-12-23 00:12:43 +01:00
README.md 👥✨ Refactor README.md: Added contributor name, initial development phase 2023-12-23 00:02:30 +01:00

README.md

Invoice Emailing Utility

Streamline the invoice distribution process with this utility, designed to integrate customer data from a CSV database and utilize email templates and settings from a YAML configuration. Automate and personalize your invoice emailing effortlessly.

Features

  • Customer Database Management: Easily manage recipient details for invoice distribution by loading information from a CSV file.
  • Dynamic Email Templating: Personalize communications with custom email templates stored and retrieved from a YAML file.
  • Secure Email Configuration: Conveniently store email account settings, including credentials and server details, in a secure YAML file.
  • Interactive Web Interface: Navigate smoothly between configuration, CSV management, and email operations with a responsive web interface.
  • Automated Email Operations: Send invoices en masse with a single click, backed by Flask for robust email processing and delivery.

Getting Started

Follow these instructions to set up and run the utility locally for development and testing.

Prerequisites

  • Python 3
  • Flask
  • PyYAML

Install the required packages using:

pip install Flask PyYAML

Installation

  1. Clone the repository:
git clone https://your-repository-url.git
  1. Navigate to the directory:
cd your-cloned-directory
  1. Launch the Flask server:
python app.py
  1. Access the application at http://localhost:5000.

Usage

  • Configuration: Adjust email settings and templates in the Configuration tab.
  • CSV Management: Import and manage customer data for invoice distribution from a CSV file.
  • Email Operations: Execute invoice sending using the loaded customer data and predefined email template.

Contributing

  • Isaak Buslovich: Initial development and ongoing maintenance.

License

This project is licensed under a custom licence. This licence permits private and non-commercial use, testing, and use by the author's employer under certain conditions. It prohibits modification, distribution, and commercial use by others without a separate licence.

See LICENSE.md for more details.

For questions regarding the use, modification, or redistribution of this software, please contact Isaak Buslovich at isaak.buslovich@potsdam.de.

Acknowledgments

  • Hats off to all contributors and inspirers for their support and ideas.