migmose 0.1.0

Tool to generate machine readable files from MIG documents

MIG_mose

MIG_mose generates machine-readable files from MIG documents (edi-energy). MIG_mose is the sister of kohlrahbi.

Tech-Stack

• MIG_mose is a Python(3.11,3.12) project.
• .docx files a processed by the python-docx library.
• EdiFact formats are used as in maus.edifact.

This is at the moment a MWE (Minimum Working Example) and will be extended in the future. See below for an overview of its features.

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

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

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 (-i, --input-dir):

  • Description: This option allows the user to specify the path to the directory containing the .docx files for the MIGs (Message Implementation Guides).
  • Example: --input_dir /path/to/input_directory

• 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. maus.edifact.EdifactFormat). 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 csv for flat Nachrichtenstruktur tables and nested_json for json files of the nested Nachrichtenstruktur tables. Default is csv.
  • Example: `--file-type "csv"

Usage Example

To use the CLI logic provided by this tool, follow the command syntax below:

migmose -i /path/to/input_directory -o /path/to/output_directory -mf "UTILMD" -mf "ORDCHG" -ft "csv"

Development

Setup

To set up the development environment, you have to install the dev dependencies.

tox -e dev

Run all tests and linters

To run the tests, you can use tox.

tox

See our Python Template Repository 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.