xmlgenerator 0.5.2__tar.gz → 0.5.3__tar.gz

xmlgenerator-0.5.3/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: xmlgenerator
+Version: 0.5.3
+Summary: Generates XML documents from XSD schemas
+Home-page: https://github.com/lexakimov/xmlgenerator
+Author: Alexey Akimov
+Author-email: lex.akimov23@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: xmlschema
+Requires-Dist: Faker
+Requires-Dist: rstr
+Requires-Dist: PyYAML
+Requires-Dist: shtab
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# XML Generator
+
+- [Русский 🇷🇺](README_RU.md)
+- [English 🇺🇸](README.md)
+
+Generates XML documents based on XSD schemas with the ability to customize data through a YAML configuration file.
+
+Simplifies the creation of test or demonstration XML data for complex schemas.
+
+## Features
+
+- Generation of XML documents based on XSD schemas
+- Customization of generated values via a YAML configuration file
+- Validation of generated documents
+- Command-line interface for convenient use
+
+## Installation
+
+### Installation via pip
+
+```bash
+pip install xmlgenerator
+```
+
+### Install executable file manually (linux)
+
+```bash
+curl -LO https://github.com/lexakimov/xmlgenerator/releases/download/v0.5.3/xmlgenerator-linux-amd64
+chmod +x xmlgenerator-linux-amd64
+sudo install xmlgenerator-linux-amd64 /usr/local/bin/xmlgenerator
+```
+
+### Install shell completions (linux)
+
+```shell
+# also available: zsh, tcsh
+xmlgenerator -C bash | sudo tee /etc/bash_completion.d/xmlgenerator
+```
+
+## Usage
+
+The generator command is `xmlgenerator`
+
+**Flags and parameters:**
+
+```
+usage: xmlgenerator [-h] [-c <config.yml>] [-l <locale>] [-o <output.xml>] [-p] [-v <validation>] [-ff] [-e <encoding>]
+                    [-s <seed>] [-d] [-V] [-C <shell>]
+                    xsd [xsd ...]
+
+Generates XML documents from XSD schemas
+
+positional arguments:
+  xsd                            paths to xsd schema(s) or directory with xsd schemas
+
+options:
+  -h, --help                     show this help message and exit
+  -c, --config <config.yml>      pass a YAML configuration file
+  -l, --locale <locale>          locale for the randomizer (default: en_US)
+  -o, --output <output.xml>      save the output to a directory or file
+  -p, --pretty                   prettify the output XML
+  -v, --validation <validation>  validate the generated XML document (none, schema, schematron; default: schema)
+  -ff, --fail-fast               terminate execution on a validation error (default: true)
+  -e, --encoding <encoding>      the output XML encoding (utf-8, windows-1251; default: utf-8)
+  -s, --seed <seed>              set the randomization seed
+  -d, --debug                    enable debug mode
+  -V, --version                  show the current version
+  -C, --completion <shell>       print a shell completion script (bash, zsh, tcsh)
+```
+
+**Examples:**
+
+- Generate XML from a single schema and print to console:
+   ```bash
+   xmlgenerator path/to/your/schema.xsd
+   ```
+
+- Generate XML from all schemas in a directory and save to the `output` folder using a configuration file:
+   ```bash
+   xmlgenerator -c config.yml -o output/ path/to/schemas/
+   ```
+
+- Generate XML from a specific schema, save to a file with pretty formatting and windows-1251 encoding:
+   ```bash
+   xmlgenerator -o output.xml -p -e windows-1251 path/to/your/schema.xsd
+   ```
+
+- Generate XML with validation disabled:
+   ```bash
+   xmlgenerator -v none path/to/your/schema.xsd
+   ```
+
+## Configuration
+
+The generator can be configured using a YAML file passed via the `-c` or `--config` option.
+
+Description and examples of configuration are in [CONFIGURATION](./CONFIGURATION.md).
+
+## Validation
+
+Generated XML documents are checked for conformance against the schema used for generation.
+By default, validation against the source XSD schema is used.
+
+If a document does not conform to the schema, execution stops immediately.
+This behavior can be disabled using the flag `-ff false` or `--fail-fast false`.
+
+To disable validation, use the flag `-v none` or `--validation none`.
+
+## Contribution
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+### Build from source
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/lexakimov/xmlgenerator.git
+   cd xmlgenerator
+   ```
+
+2. **Create and activate a virtual environment (recommended):**
+   ```bash
+   python -m venv .venv
+   ```
+    * **For Linux/macOS:**
+      ```bash
+      source .venv/bin/activate
+      ```
+    * **For Windows (Command Prompt/PowerShell):**
+      ```bash
+      .\.venv\Scripts\activate
+      ```
+
+3. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4.1. **Install the package:**
+
+   ```bash
+   pip install .
+   # or for development mode (code changes will be immediately reflected)
+   # pip install -e .
+   ```
+
+4.2. **Otherwise, build single executable:**
+
+   ```bash
+   python build_native.py
+   ```
+
+### Project Structure
+
+- `xmlgenerator/` - main project code
+- `tests/` - tests
+
+### Running Tests
+
+```bash
+pytest
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contacts
+
+For any questions or issues, please contact [lex.akimov23@gmail.com].
+
+You can also create an [Issue on GitHub](https://github.com/lexakimov/xmlgenerator/issues) to report bugs or suggest
+improvements.

xmlgenerator-0.5.3/README.md

@@ -0,0 +1,175 @@
+# XML Generator
+
+- [Русский 🇷🇺](README_RU.md)
+- [English 🇺🇸](README.md)
+
+Generates XML documents based on XSD schemas with the ability to customize data through a YAML configuration file.
+
+Simplifies the creation of test or demonstration XML data for complex schemas.
+
+## Features
+
+- Generation of XML documents based on XSD schemas
+- Customization of generated values via a YAML configuration file
+- Validation of generated documents
+- Command-line interface for convenient use
+
+## Installation
+
+### Installation via pip
+
+```bash
+pip install xmlgenerator
+```
+
+### Install executable file manually (linux)
+
+```bash
+curl -LO https://github.com/lexakimov/xmlgenerator/releases/download/v0.5.3/xmlgenerator-linux-amd64
+chmod +x xmlgenerator-linux-amd64
+sudo install xmlgenerator-linux-amd64 /usr/local/bin/xmlgenerator
+```
+
+### Install shell completions (linux)
+
+```shell
+# also available: zsh, tcsh
+xmlgenerator -C bash | sudo tee /etc/bash_completion.d/xmlgenerator
+```
+
+## Usage
+
+The generator command is `xmlgenerator`
+
+**Flags and parameters:**
+
+```
+usage: xmlgenerator [-h] [-c <config.yml>] [-l <locale>] [-o <output.xml>] [-p] [-v <validation>] [-ff] [-e <encoding>]
+                    [-s <seed>] [-d] [-V] [-C <shell>]
+                    xsd [xsd ...]
+
+Generates XML documents from XSD schemas
+
+positional arguments:
+  xsd                            paths to xsd schema(s) or directory with xsd schemas
+
+options:
+  -h, --help                     show this help message and exit
+  -c, --config <config.yml>      pass a YAML configuration file
+  -l, --locale <locale>          locale for the randomizer (default: en_US)
+  -o, --output <output.xml>      save the output to a directory or file
+  -p, --pretty                   prettify the output XML
+  -v, --validation <validation>  validate the generated XML document (none, schema, schematron; default: schema)
+  -ff, --fail-fast               terminate execution on a validation error (default: true)
+  -e, --encoding <encoding>      the output XML encoding (utf-8, windows-1251; default: utf-8)
+  -s, --seed <seed>              set the randomization seed
+  -d, --debug                    enable debug mode
+  -V, --version                  show the current version
+  -C, --completion <shell>       print a shell completion script (bash, zsh, tcsh)
+```
+
+**Examples:**
+
+- Generate XML from a single schema and print to console:
+   ```bash
+   xmlgenerator path/to/your/schema.xsd
+   ```
+
+- Generate XML from all schemas in a directory and save to the `output` folder using a configuration file:
+   ```bash
+   xmlgenerator -c config.yml -o output/ path/to/schemas/
+   ```
+
+- Generate XML from a specific schema, save to a file with pretty formatting and windows-1251 encoding:
+   ```bash
+   xmlgenerator -o output.xml -p -e windows-1251 path/to/your/schema.xsd
+   ```
+
+- Generate XML with validation disabled:
+   ```bash
+   xmlgenerator -v none path/to/your/schema.xsd
+   ```
+
+## Configuration
+
+The generator can be configured using a YAML file passed via the `-c` or `--config` option.
+
+Description and examples of configuration are in [CONFIGURATION](./CONFIGURATION.md).
+
+## Validation
+
+Generated XML documents are checked for conformance against the schema used for generation.
+By default, validation against the source XSD schema is used.
+
+If a document does not conform to the schema, execution stops immediately.
+This behavior can be disabled using the flag `-ff false` or `--fail-fast false`.
+
+To disable validation, use the flag `-v none` or `--validation none`.
+
+## Contribution
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+### Build from source
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/lexakimov/xmlgenerator.git
+   cd xmlgenerator
+   ```
+
+2. **Create and activate a virtual environment (recommended):**
+   ```bash
+   python -m venv .venv
+   ```
+    * **For Linux/macOS:**
+      ```bash
+      source .venv/bin/activate
+      ```
+    * **For Windows (Command Prompt/PowerShell):**
+      ```bash
+      .\.venv\Scripts\activate
+      ```
+
+3. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4.1. **Install the package:**
+
+   ```bash
+   pip install .
+   # or for development mode (code changes will be immediately reflected)
+   # pip install -e .
+   ```
+
+4.2. **Otherwise, build single executable:**
+
+   ```bash
+   python build_native.py
+   ```
+
+### Project Structure
+
+- `xmlgenerator/` - main project code
+- `tests/` - tests
+
+### Running Tests
+
+```bash
+pytest
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contacts
+
+For any questions or issues, please contact [lex.akimov23@gmail.com].
+
+You can also create an [Issue on GitHub](https://github.com/lexakimov/xmlgenerator/issues) to report bugs or suggest
+improvements.

{xmlgenerator-0.5.2 → xmlgenerator-0.5.3}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='xmlgenerator',
-    version='0.5.2',
+    version='0.5.3',
     packages=find_packages(exclude=("tests", "tests.*")),
     entry_points={
         'console_scripts': [

{xmlgenerator-0.5.2 → xmlgenerator-0.5.3}/xmlgenerator/arguments.py

@@ -37,49 +37,49 @@ def _get_parser():
         "-c", "--config",
         metavar="<config.yml>",
         dest="config_yaml",
-        help="pass yaml configuration file"
+        help="pass a YAML configuration file"
     )
     parser.add_argument(
         "-l", "--locale",
         metavar="<locale>",
         default="en_US",
-        help="randomizer locale (default: %(default)s)"
+        help="locale for the randomizer (default: %(default)s)"
     )
     output_arg = parser.add_argument(
         "-o", "--output",
         metavar="<output.xml>",
         dest="output_path",
-        help="save output to dir or file"
+        help="save the output to a directory or file"
     )
     parser.add_argument(
         "-p", "--pretty",
         action="store_true",
-        help="prettify output XML"
+        help="prettify the output XML"
     )
     parser.add_argument(
         "-v", "--validation",
         metavar="<validation>",
         choices=["none", "schema", "schematron"],
         default="schema",
-        help="validate generated XML document (none, schema, schematron, default is schema)"
+        help="validate the generated XML document (none, schema, schematron; default: %(default)s)"
     )
     parser.add_argument(
         "-ff", "--fail-fast",
         action="store_true",
         default="true",
-        help="terminate execution on validation error (default is true)"
+        help="terminate execution on a validation error (default: %(default)s)"
     )
     parser.add_argument(
         "-e", "--encoding",
         metavar="<encoding>",
         choices=["utf-8", "windows-1251"],
         default="utf-8",
-        help="output XML encoding (utf-8, windows-1251, default is utf-8)"
+        help="the output XML encoding (utf-8, windows-1251; default: %(default)s)"
     )
     parser.add_argument(
         "-s", "--seed",
         metavar="<seed>",
-        help="set randomization seed"
+        help="set the randomization seed"
     )
     parser.add_argument(
         "-d", "--debug",
@@ -90,14 +90,14 @@ def _get_parser():
         "-V", "--version",
         action='version',
         version='%(prog)s 0.1.0',
-        help="shows current version"
+        help="show the current version"
     )
 
     # add shell completions
     config_arg.complete = shtab.FILE
     source_arg.complete = shtab.FILE
     output_arg.complete = shtab.FILE
-    shtab.add_argument_to(parser, ["-C", "--completion"], "print shell completion script (bash, zsh, tcsh)")
+    shtab.add_argument_to(parser, ["-C", "--completion"], "print a shell completion script (bash, zsh, tcsh)")
     completion_act = [a for a in parser._actions if a.dest == 'completion']
     if completion_act:
         completion_act[0].metavar = '<shell>'

xmlgenerator-0.5.3/xmlgenerator.egg-info/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: xmlgenerator
+Version: 0.5.3
+Summary: Generates XML documents from XSD schemas
+Home-page: https://github.com/lexakimov/xmlgenerator
+Author: Alexey Akimov
+Author-email: lex.akimov23@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: xmlschema
+Requires-Dist: Faker
+Requires-Dist: rstr
+Requires-Dist: PyYAML
+Requires-Dist: shtab
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# XML Generator
+
+- [Русский 🇷🇺](README_RU.md)
+- [English 🇺🇸](README.md)
+
+Generates XML documents based on XSD schemas with the ability to customize data through a YAML configuration file.
+
+Simplifies the creation of test or demonstration XML data for complex schemas.
+
+## Features
+
+- Generation of XML documents based on XSD schemas
+- Customization of generated values via a YAML configuration file
+- Validation of generated documents
+- Command-line interface for convenient use
+
+## Installation
+
+### Installation via pip
+
+```bash
+pip install xmlgenerator
+```
+
+### Install executable file manually (linux)
+
+```bash
+curl -LO https://github.com/lexakimov/xmlgenerator/releases/download/v0.5.3/xmlgenerator-linux-amd64
+chmod +x xmlgenerator-linux-amd64
+sudo install xmlgenerator-linux-amd64 /usr/local/bin/xmlgenerator
+```
+
+### Install shell completions (linux)
+
+```shell
+# also available: zsh, tcsh
+xmlgenerator -C bash | sudo tee /etc/bash_completion.d/xmlgenerator
+```
+
+## Usage
+
+The generator command is `xmlgenerator`
+
+**Flags and parameters:**
+
+```
+usage: xmlgenerator [-h] [-c <config.yml>] [-l <locale>] [-o <output.xml>] [-p] [-v <validation>] [-ff] [-e <encoding>]
+                    [-s <seed>] [-d] [-V] [-C <shell>]
+                    xsd [xsd ...]
+
+Generates XML documents from XSD schemas
+
+positional arguments:
+  xsd                            paths to xsd schema(s) or directory with xsd schemas
+
+options:
+  -h, --help                     show this help message and exit
+  -c, --config <config.yml>      pass a YAML configuration file
+  -l, --locale <locale>          locale for the randomizer (default: en_US)
+  -o, --output <output.xml>      save the output to a directory or file
+  -p, --pretty                   prettify the output XML
+  -v, --validation <validation>  validate the generated XML document (none, schema, schematron; default: schema)
+  -ff, --fail-fast               terminate execution on a validation error (default: true)
+  -e, --encoding <encoding>      the output XML encoding (utf-8, windows-1251; default: utf-8)
+  -s, --seed <seed>              set the randomization seed
+  -d, --debug                    enable debug mode
+  -V, --version                  show the current version
+  -C, --completion <shell>       print a shell completion script (bash, zsh, tcsh)
+```
+
+**Examples:**
+
+- Generate XML from a single schema and print to console:
+   ```bash
+   xmlgenerator path/to/your/schema.xsd
+   ```
+
+- Generate XML from all schemas in a directory and save to the `output` folder using a configuration file:
+   ```bash
+   xmlgenerator -c config.yml -o output/ path/to/schemas/
+   ```
+
+- Generate XML from a specific schema, save to a file with pretty formatting and windows-1251 encoding:
+   ```bash
+   xmlgenerator -o output.xml -p -e windows-1251 path/to/your/schema.xsd
+   ```
+
+- Generate XML with validation disabled:
+   ```bash
+   xmlgenerator -v none path/to/your/schema.xsd
+   ```
+
+## Configuration
+
+The generator can be configured using a YAML file passed via the `-c` or `--config` option.
+
+Description and examples of configuration are in [CONFIGURATION](./CONFIGURATION.md).
+
+## Validation
+
+Generated XML documents are checked for conformance against the schema used for generation.
+By default, validation against the source XSD schema is used.
+
+If a document does not conform to the schema, execution stops immediately.
+This behavior can be disabled using the flag `-ff false` or `--fail-fast false`.
+
+To disable validation, use the flag `-v none` or `--validation none`.
+
+## Contribution
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+### Build from source
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/lexakimov/xmlgenerator.git
+   cd xmlgenerator
+   ```
+
+2. **Create and activate a virtual environment (recommended):**
+   ```bash
+   python -m venv .venv
+   ```
+    * **For Linux/macOS:**
+      ```bash
+      source .venv/bin/activate
+      ```
+    * **For Windows (Command Prompt/PowerShell):**
+      ```bash
+      .\.venv\Scripts\activate
+      ```
+
+3. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4.1. **Install the package:**
+
+   ```bash
+   pip install .
+   # or for development mode (code changes will be immediately reflected)
+   # pip install -e .
+   ```
+
+4.2. **Otherwise, build single executable:**
+
+   ```bash
+   python build_native.py
+   ```
+
+### Project Structure
+
+- `xmlgenerator/` - main project code
+- `tests/` - tests
+
+### Running Tests
+
+```bash
+pytest
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contacts
+
+For any questions or issues, please contact [lex.akimov23@gmail.com].
+
+You can also create an [Issue on GitHub](https://github.com/lexakimov/xmlgenerator/issues) to report bugs or suggest
+improvements.