https://github.com/codait/exchange-metadata-converter

Basic conversion utility for YAML-based metadata descriptors
https://github.com/codait/exchange-metadata-converter

Last synced: 6 days ago
JSON representation

Basic conversion utility for YAML-based metadata descriptors

• Host: GitHub
• URL: https://github.com/codait/exchange-metadata-converter
• Owner: CODAIT
• License: apache-2.0
• Created: 2020-09-28T13:37:24.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-15T21:30:23.000Z (almost 4 years ago)
• Last Synced: 2024-10-31T10:08:20.269Z (15 days ago)
• Language: Python
• Homepage:
• Size: 95.7 KB
• Stars: 1
• Watchers: 13
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PyPI version](https://badge.fury.io/py/exchange-metadata-converter.svg)](https://badge.fury.io/py/exchange-metadata-converter)

[![Build Status](https://travis-ci.org/CODAIT/exchange-metadata-converter.svg?branch=main)](https://travis-ci.org/CODAIT/exchange-metadata-converter)

## Setup

### Installing from PyPI

The package is published on [PyPI](https://pypi.org/project/exchange-metadata-converter/).

```

$ pip install exchange-metadata-converter

```

### Installing from source code

To install the package from source code, run

```

$ git clone https://github.com/CODAIT/exchange-metadata-converter.git

$ cd exchange-metadata-converter

$ pip install .

```

### Validation

The package should pass flake8 and the unit tests in the [`/tests`](/tests) directory.

 ```

 $ pip install -r test_requirements.txt

 $ flake8 .

 $ python -m unittest tests/*.py

 ```

## Running the converter

Display help:

```

$ python metadata_converter/apply.py -h

```

Replace `{{...}}` placeholders in `my.template` with values from `my.yaml`. The completed template is displayed on STDOUT.

```

$ python metadata_converter/apply.py my.yaml my.template

```

Replace `{{...}}` placeholders in `my.template` with values from `my.yaml`. The completed template is stored in `my_completed.template`.

```

$ python metadata_converter/apply.py my.yaml my.template -o my_completed.template

```

## Programmatic invocation

See example source code in [examples/](/examples).

## Templates

Example template files for DLF and OpenAIHub can be found in the [templates/](/templates) directory.

## DAX data set descriptors

Descriptor files for DAX data sets can be found in the [dax-data-set-descriptors/](/dax-data-set-descriptors) directory.

## License

[Apache-2.0](LICENSE)