Added README

master
Griffiths Lott 3 years ago
parent 5b3c56e51f
commit 3ea5cb68e8
  1. 29
      README.MD

@ -0,0 +1,29 @@
# XML Rule Parser
Attempts to parse XML into an excel document.
## Usage
### Clicking the compiled binary
- Opens a new terminal (typically cmd)
- Checks your clipboard for XML
- Asks if this is the xml you'd like to parse.
- If yes, parses XML into dataframe.
- Copies to clipboard
- Saves to Parsed XML.xlsx in the same folder as the binary.
### Running from terminal/command line
```sh
usage: XML Parser [-h] [-i INPUT] [-o OUTPUT] [--debug]
This program parses XML data into a pandas DataFrame. The XML data can come from an input file or the clipboard. If an output file is specified, the DataFrame will be written to this file in Excel format. If debug mode is
enabled, detailed logging information will be written to "xml_parse.log".
options:
-h, --help show this help message and exit
-i INPUT, --input INPUT
Path to the XML file to parse. If not specified, the program will ask for XML data from the clipboard.
-o OUTPUT, --output OUTPUT
Path to the output Excel file. If not specified, the DataFrame will be written to 'Parsed XML.xlsx' in the current directory.
--debug Enable debug mode. Detailed logging information will be written to 'xml_parse.log'.
```
Loading…
Cancel
Save