79 lines
2.1 KiB
Markdown
79 lines
2.1 KiB
Markdown
# Flask YAML Editor
|
|
|
|
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.
|
|
|
|
## 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.
|
|
|
|
## Getting Started
|
|
|
|
These instructions will get you a copy of the project up and running on your local machine for development and testing
|
|
purposes.
|
|
|
|
### Prerequisites
|
|
|
|
- Python 3
|
|
- Flask
|
|
- PyYAML
|
|
|
|
You can install Flask and PyYAML using pip:
|
|
|
|
```bash
|
|
pip install Flask PyYAML
|
|
```
|
|
|
|
### Installing
|
|
|
|
1. Clone the repository to your local machine:
|
|
|
|
```bash
|
|
git clone https://your-repository-url.git
|
|
```
|
|
|
|
2. Navigate to the cloned directory:
|
|
|
|
```bash
|
|
cd flask-yaml-editor
|
|
```
|
|
|
|
3. Start 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`.
|
|
|
|
### 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.
|
|
|
|
## Authors
|
|
|
|
- **Isaak Buslovich** - *Initial work*
|
|
|
|
## 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 the [LICENSE.md](LICENSE.md) file 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
|