Ghga Transpiler
GHGA-Transpiler - excel to JSON converter
Description
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.
Installation
We recommend installing the latest version of the GHGA transpiler using pip
pip install ghga-transpiler
Usage:
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.
Development
This package is a member of the GHGA monorepo and is
developed from the repository root rather than on its own. The repository ships a
devcontainer with the whole toolchain: open it in VS Code and run
Remote-Containers: Reopen in Container, or set the environment up directly with
just sync.
The usual tasks, run from the repository root (see ADR-0015 for the full recipe list):
just sync # install every member plus the shared dev toolchain
just test tools/ghga-transpiler # this member's test suite
just lint # ruff check + format check across the workspace
License
This repository is free to use and modify according to the Apache 2.0 License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ghga_transpiler-2.5.0.tar.gz.
File metadata
- Download URL: ghga_transpiler-2.5.0.tar.gz
- Upload date:
- Size: 15.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5111b499fd0d1d7a4d6bd17e03163dec1579006c964bbbc97c12225b19ec7489
|
|
| MD5 |
853eddb2647244994093aa07ed514448
|
|
| BLAKE2b-256 |
8d64afdbb2448566aa5219269c5209341ef2d0c46da89c7caf01477d1ce04093
|
File details
Details for the file ghga_transpiler-2.5.0-py3-none-any.whl.
File metadata
- Download URL: ghga_transpiler-2.5.0-py3-none-any.whl
- Upload date:
- Size: 21.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9dc040e7cc87b71b0efa60a1c119ac32577ed4b1fbcf7ee53a706c64bf4c6832
|
|
| MD5 |
6951fcf4c19069d539982d21e38775ab
|
|
| BLAKE2b-256 |
ad93d3cd2bf4f4e5ea4d1f2f98588b5f44f422634f91ecb2344c3c0e36c48a10
|
