Isaak
c3fe50f739
🚀 Improved business utility for sending invoices. The new README describes how to use the CSV database and the YAML email template for efficient invoice distribution.
82 lines
2.4 KiB
Markdown
82 lines
2.4 KiB
Markdown
# 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:
|
|
|
|
```bash
|
|
pip install Flask PyYAML
|
|
```
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://your-repository-url.git
|
|
```
|
|
|
|
2. Navigate to the directory:
|
|
|
|
```bash
|
|
cd your-cloned-directory
|
|
```
|
|
|
|
3. Launch the Flask server:
|
|
|
|
```bash
|
|
python app.py
|
|
```
|
|
|
|
4. 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
|
|
|
|
- **[Your Name]**: 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](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.
|