atom-feed-link-check/README.md
2023-11-11 13:33:20 +01:00

37 lines
993 B
Markdown

# atom-feed-link-check
This Python script checks an XML file for mismatches between link text and href attributes in the 'content.encoded' nodes of an ATOM feed.
## Prerequisites
- Python 3.x
- `xml.etree.ElementTree` library (usually included in Python standard library)
## Usage
1. Clone this repository or download the `feed-check.py` script.
2. Open a terminal and navigate to the directory containing the script.
3. Run the script by providing the path to your XML file:
```bash
python feed-check.py path/to/your/xml/file.xml
```
Example:
```bash
python feed-check.py example.xml
```
View the file feed-check-result.txt for any detected mismatches.
## Output
The script will print information about any mismatches found, including the title of the item, link text, and href value to the file feed-check-result.txt.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgments
Code assistance provided by ChatGPT.