GHGA-Transpiler - excel to JSON converter
The GHGA Transpiler is a Python library and command line utility to transpile the official GHGA metadata XLSX workbooks to JSON. Please note that the GHGA Transpiler does not validate that the provided metadata is compliant with the GHGA Metadata Schema. This can be achieved by running the GHGA Validator on the JSON data generated by the GHGA Transpiler.
We recommend installing the latest version of the GHGA transpiler using pip
pip install ghga-transpiler
Usage: ghga-transpiler [OPTIONS] SPREAD_SHEET [OUTPUT_FILE]
ghga-transpiler is a command line utility to transpile the official GHGA
metadata XLSX workbooks to JSON. Please note that ghga-transpiler does not
validate that the provided metadata is compliant with the GHGA Metadata
Schema. This can be achieved by running ghga-validator on the JSON data
generated by the ghga-transpiler.
Arguments:
SPREAD_SHEET The path to input file (XLSX) [required]
[OUTPUT_FILE] The path to output file (JSON).
Options:
-f, --force Override output file if it exists.
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
--help Show this message and exit.
For setting up the development environment, we rely on the devcontainer feature of vscode in combination with Docker Compose.
To use it, you have to have Docker Compose as well as vscode with its "Remote - Containers"
extension (ms-vscode-remote.remote-containers) installed.
Then open this repository in vscode and run the command
Remote-Containers: Reopen in Container from the vscode "Command Palette".
This will give you a full-fledged, pre-configured development environment including:
- infrastructural dependencies of the service (databases, etc.)
- all relevant vscode extensions pre-installed
- pre-configured linting and auto-formating
- a pre-configured debugger
- automatic license-header insertion
Moreover, inside the devcontainer, a convenience commands dev_install is available.
It installs the software with all development dependencies, installs pre-commit.
The installation is performed automatically when you build the devcontainer. However,
if you update dependencies in the ./setup.cfg or the
./requirements-dev.txt, please run it again.
This repository is free to use and modify according to the Apache 2.0 License.
This readme is autogenerate, please see readme_generation.md
for details.