✍️ Updated README.md for Invoice Email Utility
🚀 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:
parent
17e2624fd3
commit
c3fe50f739
71
README.md
71
README.md
@ -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
|
Streamline the invoice distribution process with this utility, designed to integrate customer data from a CSV database
|
||||||
application is built using Flask and serves an HTML page that interacts with the Flask backend to manage YAML data.
|
and utilize email templates and settings from a YAML configuration. Automate and personalize your invoice emailing
|
||||||
|
effortlessly.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Read YAML Data**: View the contents of a YAML file in a web interface.
|
- **Customer Database Management**: Easily manage recipient details for invoice distribution by loading information from
|
||||||
- **Update YAML Data**: Edit and save changes to the YAML file directly from the web interface.
|
a CSV file.
|
||||||
- **Simple and Responsive UI**: Built with HTML, CSS, and minimal JavaScript for a clean user experience.
|
- **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
|
## Getting Started
|
||||||
|
|
||||||
These instructions will get you a copy of the project up and running on your local machine for development and testing
|
Follow these instructions to set up and run the utility locally for development and testing.
|
||||||
purposes.
|
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
@ -20,45 +27,43 @@ purposes.
|
|||||||
- Flask
|
- Flask
|
||||||
- PyYAML
|
- PyYAML
|
||||||
|
|
||||||
You can install Flask and PyYAML using pip:
|
Install the required packages using:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install Flask PyYAML
|
pip install Flask PyYAML
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing
|
### Installation
|
||||||
|
|
||||||
1. Clone the repository to your local machine:
|
1. Clone the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://your-repository-url.git
|
git clone https://your-repository-url.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Navigate to the cloned directory:
|
2. Navigate to the directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd flask-yaml-editor
|
cd your-cloned-directory
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Start the Flask server:
|
3. Launch the Flask server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python app.py
|
python app.py
|
||||||
```
|
```
|
||||||
|
|
||||||
Replace `app.py` with the name of your main Python script.
|
4. Access the application at `http://localhost:5000`.
|
||||||
|
|
||||||
4. Open your web browser and go to `http://localhost:5000`.
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
- **View YAML Data**: The text area displays the current content of the YAML file.
|
- **Configuration**: Adjust email settings and templates in the Configuration tab.
|
||||||
- **Edit YAML Data**: Make changes in the text area and click the 'Save Data' button to update the file.
|
- **CSV Management**: Import and manage customer data for invoice distribution from a CSV file.
|
||||||
- **Reload Data**: Click the 'Reload Data' button to refresh the content from the YAML 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
|
## 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
|
by the author's employer under certain conditions. It prohibits modification, distribution, and commercial use by others
|
||||||
without a separate licence.
|
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
|
For questions regarding the use, modification, or redistribution of this software, please contact Isaak Buslovich at
|
||||||
isaak.buslovich@potsdam.de.
|
isaak.buslovich@potsdam.de.
|
||||||
|
|
||||||
## Acknowledgments
|
## Acknowledgments
|
||||||
|
|
||||||
- Hat tip to anyone whose code was used
|
- Hats off to all contributors and inspirers for their support and ideas.
|
||||||
- Inspiration
|
|
||||||
- etc
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user