xmlgenerator 0.5.2__py3-none-any.whl → 0.5.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- xmlgenerator/arguments.py +10 -10
- xmlgenerator-0.5.3.dist-info/METADATA +205 -0
- {xmlgenerator-0.5.2.dist-info → xmlgenerator-0.5.3.dist-info}/RECORD +7 -7
- xmlgenerator-0.5.2.dist-info/METADATA +0 -320
- {xmlgenerator-0.5.2.dist-info → xmlgenerator-0.5.3.dist-info}/WHEEL +0 -0
- {xmlgenerator-0.5.2.dist-info → xmlgenerator-0.5.3.dist-info}/entry_points.txt +0 -0
- {xmlgenerator-0.5.2.dist-info → xmlgenerator-0.5.3.dist-info}/licenses/LICENSE +0 -0
- {xmlgenerator-0.5.2.dist-info → xmlgenerator-0.5.3.dist-info}/top_level.txt +0 -0
xmlgenerator/arguments.py
CHANGED
|
@@ -37,49 +37,49 @@ def _get_parser():
|
|
|
37
37
|
"-c", "--config",
|
|
38
38
|
metavar="<config.yml>",
|
|
39
39
|
dest="config_yaml",
|
|
40
|
-
help="pass
|
|
40
|
+
help="pass a YAML configuration file"
|
|
41
41
|
)
|
|
42
42
|
parser.add_argument(
|
|
43
43
|
"-l", "--locale",
|
|
44
44
|
metavar="<locale>",
|
|
45
45
|
default="en_US",
|
|
46
|
-
help="randomizer
|
|
46
|
+
help="locale for the randomizer (default: %(default)s)"
|
|
47
47
|
)
|
|
48
48
|
output_arg = parser.add_argument(
|
|
49
49
|
"-o", "--output",
|
|
50
50
|
metavar="<output.xml>",
|
|
51
51
|
dest="output_path",
|
|
52
|
-
help="save output to
|
|
52
|
+
help="save the output to a directory or file"
|
|
53
53
|
)
|
|
54
54
|
parser.add_argument(
|
|
55
55
|
"-p", "--pretty",
|
|
56
56
|
action="store_true",
|
|
57
|
-
help="prettify output XML"
|
|
57
|
+
help="prettify the output XML"
|
|
58
58
|
)
|
|
59
59
|
parser.add_argument(
|
|
60
60
|
"-v", "--validation",
|
|
61
61
|
metavar="<validation>",
|
|
62
62
|
choices=["none", "schema", "schematron"],
|
|
63
63
|
default="schema",
|
|
64
|
-
help="validate generated XML document (none, schema, schematron
|
|
64
|
+
help="validate the generated XML document (none, schema, schematron; default: %(default)s)"
|
|
65
65
|
)
|
|
66
66
|
parser.add_argument(
|
|
67
67
|
"-ff", "--fail-fast",
|
|
68
68
|
action="store_true",
|
|
69
69
|
default="true",
|
|
70
|
-
help="terminate execution on validation error (default
|
|
70
|
+
help="terminate execution on a validation error (default: %(default)s)"
|
|
71
71
|
)
|
|
72
72
|
parser.add_argument(
|
|
73
73
|
"-e", "--encoding",
|
|
74
74
|
metavar="<encoding>",
|
|
75
75
|
choices=["utf-8", "windows-1251"],
|
|
76
76
|
default="utf-8",
|
|
77
|
-
help="output XML encoding (utf-8, windows-1251
|
|
77
|
+
help="the output XML encoding (utf-8, windows-1251; default: %(default)s)"
|
|
78
78
|
)
|
|
79
79
|
parser.add_argument(
|
|
80
80
|
"-s", "--seed",
|
|
81
81
|
metavar="<seed>",
|
|
82
|
-
help="set randomization seed"
|
|
82
|
+
help="set the randomization seed"
|
|
83
83
|
)
|
|
84
84
|
parser.add_argument(
|
|
85
85
|
"-d", "--debug",
|
|
@@ -90,14 +90,14 @@ def _get_parser():
|
|
|
90
90
|
"-V", "--version",
|
|
91
91
|
action='version',
|
|
92
92
|
version='%(prog)s 0.1.0',
|
|
93
|
-
help="
|
|
93
|
+
help="show the current version"
|
|
94
94
|
)
|
|
95
95
|
|
|
96
96
|
# add shell completions
|
|
97
97
|
config_arg.complete = shtab.FILE
|
|
98
98
|
source_arg.complete = shtab.FILE
|
|
99
99
|
output_arg.complete = shtab.FILE
|
|
100
|
-
shtab.add_argument_to(parser, ["-C", "--completion"], "print shell completion script (bash, zsh, tcsh)")
|
|
100
|
+
shtab.add_argument_to(parser, ["-C", "--completion"], "print a shell completion script (bash, zsh, tcsh)")
|
|
101
101
|
completion_act = [a for a in parser._actions if a.dest == 'completion']
|
|
102
102
|
if completion_act:
|
|
103
103
|
completion_act[0].metavar = '<shell>'
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: xmlgenerator
|
|
3
|
+
Version: 0.5.3
|
|
4
|
+
Summary: Generates XML documents from XSD schemas
|
|
5
|
+
Home-page: https://github.com/lexakimov/xmlgenerator
|
|
6
|
+
Author: Alexey Akimov
|
|
7
|
+
Author-email: lex.akimov23@gmail.com
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Requires-Python: >=3.6
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: lxml
|
|
15
|
+
Requires-Dist: xmlschema
|
|
16
|
+
Requires-Dist: Faker
|
|
17
|
+
Requires-Dist: rstr
|
|
18
|
+
Requires-Dist: PyYAML
|
|
19
|
+
Requires-Dist: shtab
|
|
20
|
+
Dynamic: author
|
|
21
|
+
Dynamic: author-email
|
|
22
|
+
Dynamic: classifier
|
|
23
|
+
Dynamic: description
|
|
24
|
+
Dynamic: description-content-type
|
|
25
|
+
Dynamic: home-page
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
Dynamic: requires-dist
|
|
28
|
+
Dynamic: requires-python
|
|
29
|
+
Dynamic: summary
|
|
30
|
+
|
|
31
|
+
# XML Generator
|
|
32
|
+
|
|
33
|
+
- [Русский 🇷🇺](README_RU.md)
|
|
34
|
+
- [English 🇺🇸](README.md)
|
|
35
|
+
|
|
36
|
+
Generates XML documents based on XSD schemas with the ability to customize data through a YAML configuration file.
|
|
37
|
+
|
|
38
|
+
Simplifies the creation of test or demonstration XML data for complex schemas.
|
|
39
|
+
|
|
40
|
+
## Features
|
|
41
|
+
|
|
42
|
+
- Generation of XML documents based on XSD schemas
|
|
43
|
+
- Customization of generated values via a YAML configuration file
|
|
44
|
+
- Validation of generated documents
|
|
45
|
+
- Command-line interface for convenient use
|
|
46
|
+
|
|
47
|
+
## Installation
|
|
48
|
+
|
|
49
|
+
### Installation via pip
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pip install xmlgenerator
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Install executable file manually (linux)
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
curl -LO https://github.com/lexakimov/xmlgenerator/releases/download/v0.5.3/xmlgenerator-linux-amd64
|
|
59
|
+
chmod +x xmlgenerator-linux-amd64
|
|
60
|
+
sudo install xmlgenerator-linux-amd64 /usr/local/bin/xmlgenerator
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Install shell completions (linux)
|
|
64
|
+
|
|
65
|
+
```shell
|
|
66
|
+
# also available: zsh, tcsh
|
|
67
|
+
xmlgenerator -C bash | sudo tee /etc/bash_completion.d/xmlgenerator
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Usage
|
|
71
|
+
|
|
72
|
+
The generator command is `xmlgenerator`
|
|
73
|
+
|
|
74
|
+
**Flags and parameters:**
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
usage: xmlgenerator [-h] [-c <config.yml>] [-l <locale>] [-o <output.xml>] [-p] [-v <validation>] [-ff] [-e <encoding>]
|
|
78
|
+
[-s <seed>] [-d] [-V] [-C <shell>]
|
|
79
|
+
xsd [xsd ...]
|
|
80
|
+
|
|
81
|
+
Generates XML documents from XSD schemas
|
|
82
|
+
|
|
83
|
+
positional arguments:
|
|
84
|
+
xsd paths to xsd schema(s) or directory with xsd schemas
|
|
85
|
+
|
|
86
|
+
options:
|
|
87
|
+
-h, --help show this help message and exit
|
|
88
|
+
-c, --config <config.yml> pass a YAML configuration file
|
|
89
|
+
-l, --locale <locale> locale for the randomizer (default: en_US)
|
|
90
|
+
-o, --output <output.xml> save the output to a directory or file
|
|
91
|
+
-p, --pretty prettify the output XML
|
|
92
|
+
-v, --validation <validation> validate the generated XML document (none, schema, schematron; default: schema)
|
|
93
|
+
-ff, --fail-fast terminate execution on a validation error (default: true)
|
|
94
|
+
-e, --encoding <encoding> the output XML encoding (utf-8, windows-1251; default: utf-8)
|
|
95
|
+
-s, --seed <seed> set the randomization seed
|
|
96
|
+
-d, --debug enable debug mode
|
|
97
|
+
-V, --version show the current version
|
|
98
|
+
-C, --completion <shell> print a shell completion script (bash, zsh, tcsh)
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
**Examples:**
|
|
102
|
+
|
|
103
|
+
- Generate XML from a single schema and print to console:
|
|
104
|
+
```bash
|
|
105
|
+
xmlgenerator path/to/your/schema.xsd
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
- Generate XML from all schemas in a directory and save to the `output` folder using a configuration file:
|
|
109
|
+
```bash
|
|
110
|
+
xmlgenerator -c config.yml -o output/ path/to/schemas/
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
- Generate XML from a specific schema, save to a file with pretty formatting and windows-1251 encoding:
|
|
114
|
+
```bash
|
|
115
|
+
xmlgenerator -o output.xml -p -e windows-1251 path/to/your/schema.xsd
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
- Generate XML with validation disabled:
|
|
119
|
+
```bash
|
|
120
|
+
xmlgenerator -v none path/to/your/schema.xsd
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Configuration
|
|
124
|
+
|
|
125
|
+
The generator can be configured using a YAML file passed via the `-c` or `--config` option.
|
|
126
|
+
|
|
127
|
+
Description and examples of configuration are in [CONFIGURATION](./CONFIGURATION.md).
|
|
128
|
+
|
|
129
|
+
## Validation
|
|
130
|
+
|
|
131
|
+
Generated XML documents are checked for conformance against the schema used for generation.
|
|
132
|
+
By default, validation against the source XSD schema is used.
|
|
133
|
+
|
|
134
|
+
If a document does not conform to the schema, execution stops immediately.
|
|
135
|
+
This behavior can be disabled using the flag `-ff false` or `--fail-fast false`.
|
|
136
|
+
|
|
137
|
+
To disable validation, use the flag `-v none` or `--validation none`.
|
|
138
|
+
|
|
139
|
+
## Contribution
|
|
140
|
+
|
|
141
|
+
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
|
|
142
|
+
|
|
143
|
+
### Build from source
|
|
144
|
+
|
|
145
|
+
1. **Clone the repository:**
|
|
146
|
+
```bash
|
|
147
|
+
git clone https://github.com/lexakimov/xmlgenerator.git
|
|
148
|
+
cd xmlgenerator
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
2. **Create and activate a virtual environment (recommended):**
|
|
152
|
+
```bash
|
|
153
|
+
python -m venv .venv
|
|
154
|
+
```
|
|
155
|
+
* **For Linux/macOS:**
|
|
156
|
+
```bash
|
|
157
|
+
source .venv/bin/activate
|
|
158
|
+
```
|
|
159
|
+
* **For Windows (Command Prompt/PowerShell):**
|
|
160
|
+
```bash
|
|
161
|
+
.\.venv\Scripts\activate
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
3. **Install dependencies:**
|
|
165
|
+
```bash
|
|
166
|
+
pip install -r requirements.txt
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
4.1. **Install the package:**
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
pip install .
|
|
173
|
+
# or for development mode (code changes will be immediately reflected)
|
|
174
|
+
# pip install -e .
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
4.2. **Otherwise, build single executable:**
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
python build_native.py
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Project Structure
|
|
184
|
+
|
|
185
|
+
- `xmlgenerator/` - main project code
|
|
186
|
+
- `tests/` - tests
|
|
187
|
+
|
|
188
|
+
### Running Tests
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
pytest
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## License
|
|
197
|
+
|
|
198
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
|
199
|
+
|
|
200
|
+
## Contacts
|
|
201
|
+
|
|
202
|
+
For any questions or issues, please contact [lex.akimov23@gmail.com].
|
|
203
|
+
|
|
204
|
+
You can also create an [Issue on GitHub](https://github.com/lexakimov/xmlgenerator/issues) to report bugs or suggest
|
|
205
|
+
improvements.
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
xmlgenerator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
-
xmlgenerator/arguments.py,sha256=
|
|
2
|
+
xmlgenerator/arguments.py,sha256=AifALtYzVo_j_Pawj8gX3I1YrNTJHtDjCCe5z4vSp4k,4891
|
|
3
3
|
xmlgenerator/bootstrap.py,sha256=YIgdumv_JK20Qnf_0RetoFPv344YflERklJMkNqInS8,4010
|
|
4
4
|
xmlgenerator/configuration.py,sha256=JYhz_lONxd0faUiZHG-TVEs6yocn0s__Ulwtcvq9eDs,5946
|
|
5
5
|
xmlgenerator/generator.py,sha256=FDZ8U52wpbhvbunFY_8F5CkviFs4u14NojfxPnw7zkw,30095
|
|
6
6
|
xmlgenerator/randomization.py,sha256=azXW1SxKSA9_lw1IBQDPOwSUXFEXo8IGWFD0an-eVF0,4416
|
|
7
7
|
xmlgenerator/substitution.py,sha256=v4rzqnF1p1yN0VKRDFwQM5zQbpdg9ebbrh65cnh9qxw,6078
|
|
8
8
|
xmlgenerator/validation.py,sha256=uCJjS5YmRDlAp9C-5Rd4E2Brh6_3WOG2-dSGxDiaH14,2023
|
|
9
|
-
xmlgenerator-0.5.
|
|
10
|
-
xmlgenerator-0.5.
|
|
11
|
-
xmlgenerator-0.5.
|
|
12
|
-
xmlgenerator-0.5.
|
|
13
|
-
xmlgenerator-0.5.
|
|
14
|
-
xmlgenerator-0.5.
|
|
9
|
+
xmlgenerator-0.5.3.dist-info/licenses/LICENSE,sha256=QlXK8O3UcoAYUYwVJNgB9MSM7O94ogNo_1hd9GzznUQ,1070
|
|
10
|
+
xmlgenerator-0.5.3.dist-info/METADATA,sha256=BIQSk5Y8jzaCHce-L6BdLBT4G96_z4fF6boWaBU729Y,5675
|
|
11
|
+
xmlgenerator-0.5.3.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
|
|
12
|
+
xmlgenerator-0.5.3.dist-info/entry_points.txt,sha256=ly9hKr3o4AzFUkelBZNRzyKYf-Ld4kfcffvBu1oHq54,61
|
|
13
|
+
xmlgenerator-0.5.3.dist-info/top_level.txt,sha256=jr7FbMBm8MQ6j8I_-nWzQQEseXzwSCZNXgrkWuk9P4E,13
|
|
14
|
+
xmlgenerator-0.5.3.dist-info/RECORD,,
|
|
@@ -1,320 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: xmlgenerator
|
|
3
|
-
Version: 0.5.2
|
|
4
|
-
Summary: Generates XML documents from XSD schemas
|
|
5
|
-
Home-page: https://github.com/lexakimov/xmlgenerator
|
|
6
|
-
Author: Alexey Akimov
|
|
7
|
-
Author-email: lex.akimov23@gmail.com
|
|
8
|
-
Classifier: Programming Language :: Python :: 3
|
|
9
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
-
Classifier: Operating System :: OS Independent
|
|
11
|
-
Requires-Python: >=3.6
|
|
12
|
-
Description-Content-Type: text/markdown
|
|
13
|
-
License-File: LICENSE
|
|
14
|
-
Requires-Dist: lxml
|
|
15
|
-
Requires-Dist: xmlschema
|
|
16
|
-
Requires-Dist: Faker
|
|
17
|
-
Requires-Dist: rstr
|
|
18
|
-
Requires-Dist: PyYAML
|
|
19
|
-
Requires-Dist: shtab
|
|
20
|
-
Dynamic: author
|
|
21
|
-
Dynamic: author-email
|
|
22
|
-
Dynamic: classifier
|
|
23
|
-
Dynamic: description
|
|
24
|
-
Dynamic: description-content-type
|
|
25
|
-
Dynamic: home-page
|
|
26
|
-
Dynamic: license-file
|
|
27
|
-
Dynamic: requires-dist
|
|
28
|
-
Dynamic: requires-python
|
|
29
|
-
Dynamic: summary
|
|
30
|
-
|
|
31
|
-
# XML Generator
|
|
32
|
-
|
|
33
|
-
- [Русский 🇷🇺](README_RU.md)
|
|
34
|
-
- [English 🇺🇸](README.md)
|
|
35
|
-
|
|
36
|
-
Generates XML documents based on XSD schemas with the ability to customize data through a YAML configuration file.
|
|
37
|
-
Simplifies the creation of test or demonstration XML data for complex schemas.
|
|
38
|
-
|
|
39
|
-
## Features
|
|
40
|
-
|
|
41
|
-
- Generation of XML documents based on XSD schemas
|
|
42
|
-
- Customization of generated values via a YAML configuration file
|
|
43
|
-
- Validation of generated documents
|
|
44
|
-
- Command-line interface for convenient use
|
|
45
|
-
|
|
46
|
-
## Installation
|
|
47
|
-
|
|
48
|
-
### Installation via pip
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
pip install xmlgenerator
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Build from source
|
|
55
|
-
|
|
56
|
-
1. **Clone the repository:**
|
|
57
|
-
```bash
|
|
58
|
-
git clone https://github.com/lexakimov/xmlgenerator.git
|
|
59
|
-
cd xmlgenerator
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
2. **Create and activate a virtual environment (recommended):**
|
|
63
|
-
```bash
|
|
64
|
-
python -m venv .venv
|
|
65
|
-
```
|
|
66
|
-
* **For Linux/macOS:**
|
|
67
|
-
```bash
|
|
68
|
-
source .venv/bin/activate
|
|
69
|
-
```
|
|
70
|
-
* **For Windows (Command Prompt/PowerShell):**
|
|
71
|
-
```bash
|
|
72
|
-
.\.venv\Scripts\activate
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
3. **Install dependencies:**
|
|
76
|
-
```bash
|
|
77
|
-
pip install -r requirements.txt
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
4.1. **Install the package:**
|
|
81
|
-
```bash
|
|
82
|
-
pip install .
|
|
83
|
-
# or for development mode (code changes will be immediately reflected)
|
|
84
|
-
# pip install -e .
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
4.2. **Otherwise, build single executable:**
|
|
88
|
-
```bash
|
|
89
|
-
python build_native.py
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
## CLI Usage
|
|
93
|
-
|
|
94
|
-
The main command to run the generator is `xmlgenerator`.
|
|
95
|
-
|
|
96
|
-
**Examples:**
|
|
97
|
-
|
|
98
|
-
- Generate XML from a single schema and print to console:
|
|
99
|
-
```bash
|
|
100
|
-
xmlgenerator path/to/your/schema.xsd
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
- Generate XML from all schemas in a directory and save to the `output` folder using a configuration file:
|
|
104
|
-
```bash
|
|
105
|
-
xmlgenerator -c config.yml -o output/ path/to/schemas/
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
- Generate XML from a specific schema, save to a file with pretty formatting and windows-1251 encoding:
|
|
109
|
-
```bash
|
|
110
|
-
xmlgenerator -o output.xml -p -e windows-1251 path/to/your/schema.xsd
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
- Generate XML with validation disabled:
|
|
114
|
-
```bash
|
|
115
|
-
xmlgenerator -v none path/to/your/schema.xsd
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
**Install shell completions:**
|
|
119
|
-
|
|
120
|
-
```shell
|
|
121
|
-
# also available: zsh, tcsh
|
|
122
|
-
xmlgenerator -C bash | sudo tee /etc/bash_completion.d/xmlgenerator
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
**Detailed CLI Usage:**
|
|
126
|
-
|
|
127
|
-
```
|
|
128
|
-
usage: xmlgenerator [-h] [-c <config.yml>] [-o <output.xml>] [-p] [-v <validation>] [-ff] [-e <encoding>]
|
|
129
|
-
[--seed <seed>] [-d] [-V]
|
|
130
|
-
xsd [xsd ...]
|
|
131
|
-
|
|
132
|
-
Generates XML documents from XSD schemas
|
|
133
|
-
|
|
134
|
-
positional arguments:
|
|
135
|
-
xsd paths to xsd schema(s) or directory with xsd schemas
|
|
136
|
-
|
|
137
|
-
options:
|
|
138
|
-
-h, --help show this help message and exit
|
|
139
|
-
-c, --config <config.yml> pass yaml configuration file
|
|
140
|
-
-l, --locale <locale> randomizer locale (default: en_US)
|
|
141
|
-
-o, --output <output.xml> save output to dir or file
|
|
142
|
-
-p, --pretty prettify output XML
|
|
143
|
-
-v, --validation <validation> validate generated XML document (none, schema, schematron, default is schema)
|
|
144
|
-
-ff, --fail-fast terminate execution on validation error (default is true)
|
|
145
|
-
-e, --encoding <encoding> output XML encoding (utf-8, windows-1251, default is utf-8)
|
|
146
|
-
-s, --seed <seed> set randomization seed
|
|
147
|
-
-d, --debug enable debug mode
|
|
148
|
-
-V, --version shows current version
|
|
149
|
-
-C, --completion <shell> print shell completion script (bash, zsh, tcsh)
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
## Configuration
|
|
153
|
-
|
|
154
|
-
The generator can be configured using a YAML file passed via the `-c` or `--config` option.
|
|
155
|
-
|
|
156
|
-
**Configuration File Structure:**
|
|
157
|
-
|
|
158
|
-
```yaml
|
|
159
|
-
# Global settings (apply to all schemas)
|
|
160
|
-
global:
|
|
161
|
-
|
|
162
|
-
# Regular expression to extract a substring from the source xsd schema filename.
|
|
163
|
-
# The extracted substring can be used via the `source_extracted` function.
|
|
164
|
-
# The regular expression must contain the group `extracted`.
|
|
165
|
-
# Default value: `(?P<extracted>.*).(xsd|XSD)` (extracts the filename without extension).
|
|
166
|
-
source_filename: ...
|
|
167
|
-
|
|
168
|
-
# Filename template for saving the generated document.
|
|
169
|
-
# Default value: `{{ source_extracted }}_{{ uuid }}` (xsd schema filename + random UUID)
|
|
170
|
-
output_filename: ...
|
|
171
|
-
|
|
172
|
-
# Random value generator settings
|
|
173
|
-
randomization:
|
|
174
|
-
# Probability of adding optional elements (0.0-1.0)
|
|
175
|
-
# Default value: 0.5
|
|
176
|
-
probability: 1
|
|
177
|
-
# Limit for the minimal number of elements
|
|
178
|
-
min_occurs: 0
|
|
179
|
-
# Limit for the maximum number of elements
|
|
180
|
-
max_occurs: 5
|
|
181
|
-
# Minimum string length
|
|
182
|
-
min_length: 5
|
|
183
|
-
# Maximum string length
|
|
184
|
-
max_length: 20
|
|
185
|
-
# Minimum numeric value
|
|
186
|
-
min_inclusive: 10
|
|
187
|
-
# Maximum numeric value
|
|
188
|
-
max_inclusive: 1000000
|
|
189
|
-
|
|
190
|
-
# Override generated values for tags and attributes.
|
|
191
|
-
# Key - string or regular expression to match the tag/attribute name.
|
|
192
|
-
# Value - string with optional use of placeholders:
|
|
193
|
-
# `{{ function }}` - substitutes the value provided by the predefined function.
|
|
194
|
-
# `{{ function | modifier }}` - same, but with a modifier [ global | local ].
|
|
195
|
-
# - `global` - a single value will be used along all generation.
|
|
196
|
-
# - `local` - a single value will be used in context of current document.
|
|
197
|
-
#
|
|
198
|
-
# The list of available functions is below.
|
|
199
|
-
# The order of entries matters; the first matching override will be selected.
|
|
200
|
-
# Key matching is case-insensitive.
|
|
201
|
-
value_override:
|
|
202
|
-
name_regexp_1: "static value"
|
|
203
|
-
name_regexp_2: "{{ function_call }}"
|
|
204
|
-
"name_regexp_\d": "static-text-and-{{ function_call }}"
|
|
205
|
-
name: "static-text-and-{{ function_call }}-{{ another_function_call }}"
|
|
206
|
-
|
|
207
|
-
# Extend/override global settings for specific files.
|
|
208
|
-
# Key - string or regular expression to match the xsd filename(s).
|
|
209
|
-
# The order of entries matters; the first matching override will be selected.
|
|
210
|
-
# Key matching is case-insensitive.
|
|
211
|
-
specific:
|
|
212
|
-
# Each value can have the same set of parameters as the global section
|
|
213
|
-
"SCHEM.*":
|
|
214
|
-
# for schemas named "SCHEM.*", xml document names will only contain UUIDv4 + '.xml'
|
|
215
|
-
output_filename: "{{ uuid }}"
|
|
216
|
-
# Random value generator settings for schemas named "SCHEM.*"
|
|
217
|
-
randomization:
|
|
218
|
-
# for schemas named "SCHEM.*", the probability of adding optional elements will be 30%
|
|
219
|
-
probability: 0.3
|
|
220
|
-
value_override:
|
|
221
|
-
# override the value set by the global configuration
|
|
222
|
-
name_regexp_1: "static value"
|
|
223
|
-
# reset overrides for tags/attributes containing 'name' set by the global configuration
|
|
224
|
-
name:
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
Configuration Priority:
|
|
228
|
-
|
|
229
|
-
- specific settings
|
|
230
|
-
- global settings
|
|
231
|
-
- default settings
|
|
232
|
-
|
|
233
|
-
### Placeholder Functions
|
|
234
|
-
|
|
235
|
-
In the `value_override` sections, you can specify either a string value or special placeholders:
|
|
236
|
-
|
|
237
|
-
- `{{ function }}` - Substitutes the value provided by the predefined function.
|
|
238
|
-
- `{{ function | modifier }}` - Same, but with a modifier `[ global | local ]`, where:
|
|
239
|
-
- `global`: The function will generate and use *the same single value* throughout the *entire generation process*
|
|
240
|
-
for all documents.
|
|
241
|
-
- `local`: The function will generate and use *the same single value* within the scope of *a single generated
|
|
242
|
-
document*.
|
|
243
|
-
- No modifier: A new value is generated each time the function is called.
|
|
244
|
-
|
|
245
|
-
**List of Placeholder Functions:**
|
|
246
|
-
|
|
247
|
-
| Function | Description |
|
|
248
|
-
|------------------------------------|------------------------------------------------------------------------------------------------------------|
|
|
249
|
-
| `source_filename` | Filename of the source xsd schema with extension (e.g., `schema.xsd`) |
|
|
250
|
-
| `source_extracted` | String extracted from the source xsd filename using the regex specified in `source_filename_extract_regex` |
|
|
251
|
-
| `output_filename` | String described by the `output_filename_template` configuration parameter |
|
|
252
|
-
| `uuid` | Random UUIDv4 |
|
|
253
|
-
| `regex("pattern")` | Random string value matching the specified regular expression |
|
|
254
|
-
| `any('A', "B", C)` | Random value from enumeration |
|
|
255
|
-
| `number(A, B)` | Random number between A and B |
|
|
256
|
-
| `date("2010-01-01", "2025-01-01")` | Random date within the specified range |
|
|
257
|
-
| `last_name` | Last Name |
|
|
258
|
-
| `first_name` | First Name |
|
|
259
|
-
| `middle_name` | Middle Name |
|
|
260
|
-
| `address_text` | Address |
|
|
261
|
-
| `administrative_unit` | Administrative Unit (e.g., District) |
|
|
262
|
-
| `house_number` | House Number |
|
|
263
|
-
| `city_name` | City Name |
|
|
264
|
-
| `postcode` | Postal Code |
|
|
265
|
-
| `company_name` | Company Name |
|
|
266
|
-
| `bank_name` | Bank Name |
|
|
267
|
-
| `phone_number` | Phone Number |
|
|
268
|
-
| `inn_fl` | Individual Taxpayer Number (Physical Person) |
|
|
269
|
-
| `inn_ul` | Taxpayer Identification Number (Legal Entity) |
|
|
270
|
-
| `ogrn_ip` | Primary State Registration Number (Individual Entrepreneur) |
|
|
271
|
-
| `ogrn_fl` | Primary State Registration Number (Physical Person) |
|
|
272
|
-
| `kpp` | Reason Code for Registration |
|
|
273
|
-
| `snils_formatted` | SNILS (Personal Insurance Account Number) in the format `123-456-789 90` |
|
|
274
|
-
| `email` | Random email address |
|
|
275
|
-
|
|
276
|
-
**Configuration Examples:**
|
|
277
|
-
|
|
278
|
-
```yaml
|
|
279
|
-
# TODO Add configuration examples.
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
## Validation
|
|
285
|
-
|
|
286
|
-
Generated XML documents are checked for conformance against the schema used for generation.
|
|
287
|
-
By default, validation against the source XSD schema is used.
|
|
288
|
-
|
|
289
|
-
If a document does not conform to the schema, execution stops immediately.
|
|
290
|
-
This behavior can be disabled using the flag `-ff false` or `--fail-fast false`.
|
|
291
|
-
|
|
292
|
-
To disable validation, use the flag `-v none` or `--validation none`.
|
|
293
|
-
|
|
294
|
-
## Contribution
|
|
295
|
-
|
|
296
|
-
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
|
|
297
|
-
|
|
298
|
-
### Project Structure
|
|
299
|
-
|
|
300
|
-
- `xmlgenerator/` - main project code
|
|
301
|
-
- `tests/` - tests
|
|
302
|
-
|
|
303
|
-
### Running Tests
|
|
304
|
-
|
|
305
|
-
```bash
|
|
306
|
-
pytest
|
|
307
|
-
```
|
|
308
|
-
|
|
309
|
-
---
|
|
310
|
-
|
|
311
|
-
## License
|
|
312
|
-
|
|
313
|
-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
|
314
|
-
|
|
315
|
-
## Contacts
|
|
316
|
-
|
|
317
|
-
For any questions or issues, please contact [lex.akimov23@gmail.com].
|
|
318
|
-
|
|
319
|
-
You can also create an [Issue on GitHub](https://github.com/lexakimov/xmlgenerator/issues) to report bugs or suggest
|
|
320
|
-
improvements.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|