Metadata-Version: 2.4
Name: msconsconverter
Version: 2.0.0
Summary: Converts MSCONS (EDIFACT) to CSV
Author: vdmitriyev
License-Expression: MIT
Project-URL: Homepage, https://github.com/vdmitriyev/msconsconverter
Project-URL: Issues, https://github.com/vdmitriyev/msconsconverter/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.2.0
Requires-Dist: typer>=0.15.2
Dynamic: license-file

## About

Converts MSCONS (EDIFACT) to CSV.

## Installation

### Using pip

Install latest related version
```
pip install --upgrade msconsconverter
```

Install latest version from source code
```
pip install git+https://github.com/vdmitriyev/msconsconverter.git
```

## Usage: CLI

* Get help
```
python -m msconsconverter convert --help
```
* Convert by providing a `directory` with data as input
```
python -m msconsconverter convert --input-directory tests/data --output-directory tests/data/output
```
* Convert by providing a `directory` with data as input in a verbose/debug mode
```
python -m msconsconverter convert --debug --input-directory tests/data --output-directory tests/data/output
```
* Convert by providing a `file` with data as input in a verbose/debug mode
```
python -m msconsconverter convert --debug --input-file tests/data/MSCONS_TL_SAMPLE01.txt --output-directory tests/data/output
```

## Usage: CLI --help example

![](https://raw.githubusercontent.com/vdmitriyev/msconsconverter/master/docs/cli-image.png)

## Development: HowTo

#### Dependencies: Overview

* Python > 3.7
* requirements/requirements-prod.txt

#### Dependencies: Clone and Install Dependencies

* Clone repo
```
git clone https://github.com/vdmitriyev/msconsconverter
```
* Install dependencies or use ```scripts/cmdInitiateEnv.bat```
```
pip install -r requirements/requirements.txt
pip install -r requirements/requirements-dev.txt
```

#### Development: Run Tests

```
python -m pytest -s
```

## Materials on MSCONS (EDIFACT)

* [EDIFACT - English](https://en.wikipedia.org/wiki/EDIFACT)
* [EDIFACT - German](https://de.wikipedia.org/wiki/EDIFACT)
* [EDI@Energy MSCONS](https://www.edi-energy.de/index.php?id=38) -> format description, see "Bewegungsdaten" section
* http://www.edi-energy.de/
* [Various Usages](https://www.bundesnetzagentur.de/DE/Service-Funktionen/Beschlusskammern/Beschlusskammer6/BK6_31_GPKE_und_GeLiGas/BK6_GPKE_undGeLi_Gas_node.html) -> see "GPKE" section

## License

MIT
