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-0034 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.

Metadata

Release files for ghga_transpiler 2.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ghga_transpiler 2.5.1
File	Size	Uploaded
ghga_transpiler-2.5.1.tar.gz	16.0 kB	Sep 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ghga_transpiler 2.5.1
File	Interpreter	ABI	Platform	Reset
ghga_transpiler-2.5.1-py3-none-any.whl 21.4 kB Sep 30, 2026	Python 3	none	any	Details

Total release size: 37.4 kB

Release files / ghga_transpiler-2.5.1.tar.gz

Download URL	ghga_transpiler-2.5.1.tar.gz
Size	16.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`8e91565fc81a2736a06ee8de25fc490d98eac770c37660cdbe0b023fa20e7ff9`
BLAKE2b-256 checksum How to use checksums	`9a7fe9916ab1b3a3baf23d80a25105b3652d8ad92b8778138c181bffd68c9b6b`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","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}`

Release files / ghga_transpiler-2.5.1-py3-none-any.whl

Download URL	ghga_transpiler-2.5.1-py3-none-any.whl
Size	21.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`62f28338db098ea23eb506decce09b0c0197aa19e77634be1e600a98d2569716`
BLAKE2b-256 checksum How to use checksums	`c3ef2e2d4ef01a49b5160fb3de2434dd02085dc24fd881b020145c4c6efd5ffb`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","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}`