| Name | migmose JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | None |
| Summary | Tool to generate machine readable files from MIG documents |
| upload_time | 2024-10-08 14:25:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
automation
bdew
edi@energy
mig
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MIG_mose
[](LICENSE)
MIG_mose generates machine-readable files from MIG `.docx` documents ([edi-energy](https://www.edi-energy.de/index.php?id=38)).
MIG_mose is the sister of [kohlrahbi](https://github.com/Hochfrequenz/kohlrahbi).
If you're looking for a tool to process the **official** BDEW XMLs for MIGs (available since 2024), checkout [fundamend](https://github.com/Hochfrequenz/xml-fundamend-python).
## Tech-Stack
- MIG_mose is a Python(3.11,3.12) project.
- .docx files a processed by the [python-docx](https://python-docx.readthedocs.io/en/latest/) library.
- EdiFact formats are used as in [efoli](https://github.com/Hochfrequenz/efoli)).
- syrupy for unittest snapshots
## Installation
MIG_mose is a Python-based tool.
Therefore, you have to make sure, that Python is running on your machine.
We recommend using virtual environments to keep your system clean.
Create a new virtual environment with
```bash
python -m venv .venv
```
The activation of the virtual environment depends on your used OS.
**Windows**
```
.venv\Scripts\activate
```
**MacOS/Linux**
```
source .venv/bin/activate
```
Finally, install the package with
```bash
pip install migmose
```
## Features And How To Use Them
At this point, MIG_mose works as a command-line interface tool (CLI).
There are several flags available to provide a user-friendly way to interact with MIG_mose.
Below the available options are listed:
- **Input Directory (`-eemp`, `--edi-energy-mirror-path`):**
- Description: This option allows the user to specify the path to a edi-energy-mirror-like repository which contains .docx files for the MIGs (Message Implementation Guides) in subdirectories structured by the format version.
- Example: `--edi-energy-mirror-path /path/to/edi_energy_mirror`
- **Message Format (`-mf`, `--message-format`):**
- Description: This option defines the set of message formats to be parsed. Users can specify multiple message formats by providing multiple values. The formats are EdiFact formats (cf. [efoli.EdifactFormat](https://github.com/Hochfrequenz/efoli/blob/src/efoli/edifact_format.py)). If no format is specified, all formats are parsed.
- Example: `--message_format "UTILMD" --message_format "ORDCHG"`
- **Output Directory (`-o`, `--output-dir`):**
- Description: This option allows the user to specify the path to the directory which should contain the output files generated by the tool. If the directory does not exist, it will be created automatically.
- Example: `--output_dir /path/to/output_directory`
- **Output File Type (`-ft`, `--file-type`):**
- Description: Defines the output format. Choose between (Default is `csv`):
- `csv` for flat Nachrichtenstruktur tables
- `nested_json` for json files of the nested Nachrichtenstruktur tables
- `reduced_nested_json` for a reduced nested Nachrichtenstruktur
- `sgh_json` for segmentgrouphierarchy files (cf. [MAUS sgh](https://github.com/Hochfrequenz/edifact-templates/tree/b024e3671deae9aec7e8ea29e74fa48257f6ccfe/segment_group_hierarchies))
- `tree` for .tree files (cf. [MAUS tree](https://github.com/Hochfrequenz/mig_ahb_utility_stack/blob/5cce94069ead5aa63d4b9ac7f5e0fcec0bf608ea/src/maus/reader/tree_to_sgh.py))
- Example: `--file-type "csv"
- **Format Version (`-fv`, `--format-version`):**
- Description: Defines the format version.
- Example: `--format-version "FV2310"
### Usage Example
To use the CLI logic provided by this tool, follow the command syntax below:
```bash
migmose -eemp /path/to/edi_energy_mirror -o /path/to/output_directory -mf "UTILMD" -mf "ORDCHG" -ft "csv" -fv "FV2310"
```
## Development
### Setup
To set up the development environment, you have to install the dev dependencies.
```bash
tox -e dev
```
### Run all tests and linters
To run the tests, you can use tox.
```bash
tox
```
To update the test snapshots run
```bash
tox -e update_snapshots
```
See our [Python Template Repository](https://github.com/Hochfrequenz/python_template_repository#how-to-use-this-repository-on-your-machine) for detailed explanations.
## Contribute
You are very welcome to contribute to this template repository by opening a pull request against the main branch.
## Related Tools and Context
This repository is part of the [Hochfrequenz Libraries and Tools for a truly digitized market communication](https://github.com/Hochfrequenz/digital_market_communication/).
Raw data
{
"_id": null,
"home_page": null,
"name": "migmose",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "automation, bdew, edi@energy, mig",
"author": null,
"author_email": "Kevin Krechan <kevin.krechan@hochfrequenz.de>",
"download_url": "https://files.pythonhosted.org/packages/9f/98/76fdf3cfcf1adc47ab0cab49e073ae6a90f1fdeea3deb5d58e4d993ac720/migmose-0.2.4.tar.gz",
"platform": null,
"description": "\n\n# MIG_mose\n\n[](LICENSE)\n\n\n\n\n\n\n\nMIG_mose generates machine-readable files from MIG `.docx` documents ([edi-energy](https://www.edi-energy.de/index.php?id=38)).\nMIG_mose is the sister of [kohlrahbi](https://github.com/Hochfrequenz/kohlrahbi).\n\nIf you're looking for a tool to process the **official** BDEW XMLs for MIGs (available since 2024), checkout [fundamend](https://github.com/Hochfrequenz/xml-fundamend-python).\n\n## Tech-Stack\n- MIG_mose is a Python(3.11,3.12) project.\n- .docx files a processed by the [python-docx](https://python-docx.readthedocs.io/en/latest/) library.\n- EdiFact formats are used as in [efoli](https://github.com/Hochfrequenz/efoli)).\n- syrupy for unittest snapshots\n\n## Installation\nMIG_mose is a Python-based tool.\nTherefore, you have to make sure, that Python is running on your machine.\n\nWe recommend using virtual environments to keep your system clean.\n\nCreate a new virtual environment with\n```bash\npython -m venv .venv\n```\n\nThe activation of the virtual environment depends on your used OS.\n\n**Windows**\n```\n.venv\\Scripts\\activate\n```\n**MacOS/Linux**\n```\nsource .venv/bin/activate\n```\nFinally, install the package with\n\n```bash\npip install migmose\n```\n\n## Features And How To Use Them\n\nAt this point, MIG_mose works as a command-line interface tool (CLI).\nThere are several flags available to provide a user-friendly way to interact with MIG_mose.\nBelow the available options are listed:\n\n- **Input Directory (`-eemp`, `--edi-energy-mirror-path`):**\n - Description: This option allows the user to specify the path to a edi-energy-mirror-like repository which contains .docx files for the MIGs (Message Implementation Guides) in subdirectories structured by the format version.\n - Example: `--edi-energy-mirror-path /path/to/edi_energy_mirror`\n\n- **Message Format (`-mf`, `--message-format`):**\n - Description: This option defines the set of message formats to be parsed. Users can specify multiple message formats by providing multiple values. The formats are EdiFact formats (cf. [efoli.EdifactFormat](https://github.com/Hochfrequenz/efoli/blob/src/efoli/edifact_format.py)). If no format is specified, all formats are parsed.\n - Example: `--message_format \"UTILMD\" --message_format \"ORDCHG\"`\n\n- **Output Directory (`-o`, `--output-dir`):**\n - Description: This option allows the user to specify the path to the directory which should contain the output files generated by the tool. If the directory does not exist, it will be created automatically.\n - Example: `--output_dir /path/to/output_directory`\n- **Output File Type (`-ft`, `--file-type`):**\n - Description: Defines the output format. Choose between (Default is `csv`):\n - `csv` for flat Nachrichtenstruktur tables\n - `nested_json` for json files of the nested Nachrichtenstruktur tables\n - `reduced_nested_json` for a reduced nested Nachrichtenstruktur\n - `sgh_json` for segmentgrouphierarchy files (cf. [MAUS sgh](https://github.com/Hochfrequenz/edifact-templates/tree/b024e3671deae9aec7e8ea29e74fa48257f6ccfe/segment_group_hierarchies))\n - `tree` for .tree files (cf. [MAUS tree](https://github.com/Hochfrequenz/mig_ahb_utility_stack/blob/5cce94069ead5aa63d4b9ac7f5e0fcec0bf608ea/src/maus/reader/tree_to_sgh.py))\n - Example: `--file-type \"csv\"\n- **Format Version (`-fv`, `--format-version`):**\n - Description: Defines the format version.\n - Example: `--format-version \"FV2310\"\n\n### Usage Example\n\nTo use the CLI logic provided by this tool, follow the command syntax below:\n\n```bash\nmigmose -eemp /path/to/edi_energy_mirror -o /path/to/output_directory -mf \"UTILMD\" -mf \"ORDCHG\" -ft \"csv\" -fv \"FV2310\"\n```\n\n## Development\n\n### Setup\n\nTo set up the development environment, you have to install the dev dependencies.\n\n```bash\ntox -e dev\n```\n\n### Run all tests and linters\n\nTo run the tests, you can use tox.\n\n```bash\ntox\n```\nTo update the test snapshots run\n```bash\ntox -e update_snapshots\n```\nSee our [Python Template Repository](https://github.com/Hochfrequenz/python_template_repository#how-to-use-this-repository-on-your-machine) for detailed explanations.\n\n## Contribute\n\nYou are very welcome to contribute to this template repository by opening a pull request against the main branch.\n\n## Related Tools and Context\n\nThis repository is part of the [Hochfrequenz Libraries and Tools for a truly digitized market communication](https://github.com/Hochfrequenz/digital_market_communication/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tool to generate machine readable files from MIG documents",
"version": "0.2.4",
"project_urls": {
"Changelog": "https://github.com/Hochfrequenz/migmose/releases",
"Homepage": "https://github.com/Hochfrequenz/migmose"
},
"split_keywords": [
"automation",
" bdew",
" edi@energy",
" mig"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ede115ece8114c0f784621dd584f4c1a685cafb59192d7b165f4dc9c57b5769",
"md5": "e5ec5b6e7124bca86208995f38f9961b",
"sha256": "76956346306209c50397301065408fcf6a08945dfeb5c80b534bda04ce828533"
},
"downloads": -1,
"filename": "migmose-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5ec5b6e7124bca86208995f38f9961b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 17349,
"upload_time": "2024-10-08T14:25:06",
"upload_time_iso_8601": "2024-10-08T14:25:06.452988Z",
"url": "https://files.pythonhosted.org/packages/1e/de/115ece8114c0f784621dd584f4c1a685cafb59192d7b165f4dc9c57b5769/migmose-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f9876fdf3cfcf1adc47ab0cab49e073ae6a90f1fdeea3deb5d58e4d993ac720",
"md5": "1fb02eff25ff621578b1c41d7a71ad96",
"sha256": "c720d4a1ba1d8c18f43f7364f65f17283bff33d0d961c60a96124762d82f1f89"
},
"downloads": -1,
"filename": "migmose-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "1fb02eff25ff621578b1c41d7a71ad96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 397803,
"upload_time": "2024-10-08T14:25:08",
"upload_time_iso_8601": "2024-10-08T14:25:08.995049Z",
"url": "https://files.pythonhosted.org/packages/9f/98/76fdf3cfcf1adc47ab0cab49e073ae6a90f1fdeea3deb5d58e4d993ac720/migmose-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 14:25:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Hochfrequenz",
"github_project": "migmose",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "migmose"
}
