Isaak/cuori
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

✍️ Updated README.md for Invoice Email Utility

Browse Source 
🚀 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.
This commit is contained in:
Isaak Buslovich 2023-12-22 23:58:58 +01:00
parent 17e2624fd3
commit c3fe50f739
Signed by: Isaak
GPG Key ID: EEC31D6437FBCC63
1 changed files with 37 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -1,18 +1,25 @@
# Flask YAML Editor
# Invoice Emailing Utility
Flask YAML Editor is a web application that provides an interface for reading and updating YAML file content. This
application is built using Flask and serves an HTML page that interacts with the Flask backend to manage YAML data.
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
- **Read YAML Data**: View the contents of a YAML file in a web interface.
- **Update YAML Data**: Edit and save changes to the YAML file directly from the web interface.
- **Simple and Responsive UI**: Built with HTML, CSS, and minimal JavaScript for a clean user experience.
- **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
These instructions will get you a copy of the project up and running on your local machine for development and testing
purposes.
Follow these instructions to set up and run the utility locally for development and testing.
### Prerequisites
@ -20,45 +27,43 @@ purposes.
- Flask
- PyYAML
You can install Flask and PyYAML using pip:
Install the required packages using:
```bash
pip install Flask PyYAML
```
### Installing
### Installation
1. Clone the repository to your local machine:
1. Clone the repository:
```bash
git clone https://your-repository-url.git
```
2. Navigate to the cloned directory:
2. Navigate to the directory:
```bash
cd flask-yaml-editor
cd your-cloned-directory
```
3. Start the Flask server:
3. Launch the Flask server:
```bash
python app.py
```
Replace `app.py` with the name of your main Python script.
4. Open your web browser and go to `http://localhost:5000`.
4. Access the application at `http://localhost:5000`.
### Usage
- **View YAML Data**: The text area displays the current content of the YAML file.
- **Edit YAML Data**: Make changes in the text area and click the 'Save Data' button to update the file.
- **Reload Data**: Click the 'Reload Data' button to refresh the content from the YAML file.
- **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.
## Authors
## Contributing
- **Isaak Buslovich** - *Initial work*
- **[Your Name]**: Initial development and ongoing maintenance.
## License
@ -66,13 +71,11 @@ This project is licensed under a custom licence. This licence permits private an
by the author's employer under certain conditions. It prohibits modification, distribution, and commercial use by others
without a separate licence.
See the [LICENSE.md](LICENSE.md) file for more details.
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
- Hat tip to anyone whose code was used
- Inspiration
- etc
- Hats off to all contributors and inspirers for their support and ideas.