YAML Format Fixer is a Flask web application designed to fix formatting issues in YAML files. It allows users to upload YAML files, processes them to ensure proper formatting, and then provides both the fixed YAML file and a report detailing the changes made.
- Upload YAML files for formatting.
- Automatic addition of necessary YAML document markers.
- Adjustment of comment indentation for consistency.
- Removal of unnecessary trailing whitespaces.
- Download the fixed YAML file and a report of changes.
- View changes directly on the web page for immediate review.
Before running this application, ensure you have the following installed:
- Python 3
- Flask
- Other dependencies (refer to
requirements.txt)
To set up the application on your local machine:
- Clone the repository:
git clone https://github.com//YAML-Format-Fixer-fe.git
csharp
- Change into the project directory:
cd YAML-Format-Fixer-fe
markdown
- Install required Python packages:
pip install -r requirements.txt
yaml
To run the application:
- Start the Flask server:
python app.py
csharp
- Open your web browser and navigate to
http://127.0.0.1:5000. - Upload a YAML file using the provided form.
- View the changes and download the processed file and change report.
Contributions to this project are welcome! Please fork the repository and submit a pull request with your changes.
This project is licensed under the MIT License - see the LICENSE file for details.
Make sure to replace with your actual GitHub username or organization name. Also, if there are additional steps specific to your project or other details you'd like to include, feel free to add them to the README.
Once you've created the README file, place it in the root directory of your repository. A well-documented README helps users understand how to use your project and encourages contributions from the community.