|
1 |
| -Blue Yonder CSV to XML converter |
2 |
| -================================ |
| 1 | +# Blue Yonder CSV to XML converter |
3 | 2 |
|
4 | 3 | [](https://travis-ci.org/blue-yonder/di-csv2xml)
|
5 | 4 |
|
6 | 5 | This tool is intended to convert a `.csv` file into an `.xml` file ready to be sent to the
|
7 | 6 | Blue Yonder Supply and Demand API. This tool has no schema information and therefore does not
|
8 | 7 | perform any validation besides checking for valid `UTF8` encoding.
|
9 | 8 |
|
10 |
| -Installation |
11 |
| ------------- |
12 |
| - |
13 |
| -### Binary executable |
14 |
| - |
15 |
| -You can [download a binary executable](https://github.com/blue-yonder/di-csv2xml/releases) (for |
16 |
| -64Bit OS-X, Windows and Linux) from the release section. |
17 |
| - |
18 |
| -### From source |
19 |
| - |
20 |
| -You can build a binary executable yourself using: |
21 |
| - |
22 |
| -```bash |
23 |
| -git clone https://github.com/blue-yonder/di-csv2xml.git |
24 |
| -cd di-csv2xml |
25 |
| -cargo build --release |
26 |
| -``` |
27 |
| - |
28 |
| -You will find the executable in the `.\target\release\` directory. |
29 |
| - |
30 |
| -You can install cargo from [here](https://rustup.rs) if it is not installed. |
31 |
| - |
32 |
| -### Homebrew |
33 |
| - |
34 |
| -If you are a MacOS user, you can use `homebrew` to install `di-csv2xml`: |
35 |
| - |
36 |
| -```bash |
37 |
| -brew install by-stehessel/BlueYonder/di-csv2xml |
38 |
| -``` |
39 |
| - |
40 |
| -Usage |
41 |
| ------ |
| 9 | +## Usage |
42 | 10 |
|
43 | 11 | ```bash
|
44 | 12 | di-csv2xml --category Category --input input.csv --output output.xml
|
@@ -110,8 +78,46 @@ As this tool does not provide any schema validation, it is important to note tha
|
110 | 78 | Any typo in the parameter `category` or the header column of the csv-file is directly translated into the
|
111 | 79 | dedicated XML-tag, leading to potential errors when attempting to process the XML-file further.
|
112 | 80 |
|
113 |
| -Support |
114 |
| -------- |
| 81 | +## Installation |
| 82 | + |
| 83 | +### Binary executable |
| 84 | + |
| 85 | +You can [download a binary executable](https://github.com/blue-yonder/di-csv2xml/releases) (for |
| 86 | +64Bit OS-X, Windows and Linux) from the release section. |
| 87 | + |
| 88 | +### From source |
| 89 | + |
| 90 | +You can build a binary executable yourself using: |
| 91 | + |
| 92 | +```bash |
| 93 | +git clone https://github.com/blue-yonder/di-csv2xml.git |
| 94 | +cd di-csv2xml |
| 95 | +cargo build --release |
| 96 | +``` |
| 97 | + |
| 98 | +You will find the executable in the `.\target\release\` directory. |
| 99 | + |
| 100 | +You can install cargo from [here](https://rustup.rs) if it is not installed. |
| 101 | + |
| 102 | +### Homebrew |
| 103 | + |
| 104 | +If you are a MacOS user, you can use `homebrew` to install `di-csv2xml`: |
| 105 | + |
| 106 | +```bash |
| 107 | +brew install by-stehessel/BlueYonder/di-csv2xml |
| 108 | +``` |
| 109 | + |
| 110 | +## Benchmarks |
| 111 | + |
| 112 | +This tool uses [criterion](https://github.com/bheisler/criterion.rs) for benchmarking. You can execute the benchmarks with: |
| 113 | + |
| 114 | +```shell |
| 115 | +cargo bench |
| 116 | +``` |
| 117 | + |
| 118 | +You can find a report with plots in `target/criterion/report/index.html`. |
| 119 | + |
| 120 | +## Support |
115 | 121 |
|
116 | 122 | This tool is provided as is under an MIT license without any warranty or SLA. You are free to use
|
117 | 123 | it as part for any purpose, but the responsibility for operating it resides with you. We appreciate
|
|
0 commit comments