Skip to main content

Hatch Yaml Compile

Made with Python

A hatch build hook that takes yaml files and converts them to msgpack. This way, your code can ship with msgpack data files for lightning-fast conversion, but your repo can contain easy-to-maintain yaml.

Getting Started

Prerequisites

  • Python 3.10+

  • git (if installing from source, or contributing to the project)

Installation

Installation

To set up hatch-yaml-compile for your project you just need to put it in your project’s pyproject.toml file as a build-system requirement:

[build-system]
requires = ["hatchling", "hatch-yaml-compile"]
build-backend = "hatchling.build"

Usage

Now you’ll need to configure the build scripts you want to run. This is done by adding an array of scripts to the tool.hatch.build.hooks.build-scripts.scripts key in your pyproject.toml file. In practice this looks like:

[tool.hatch.build.hooks.convert-data-file.options]
pattern = "*.yaml"
target_format = "msgpack"
remove_source_files = true

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

Metadata

Release files for hatch-compile-yaml 18.0.0

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

Source distribution (sdist)

Source distribution for hatch-compile-yaml 18.0.0
File Size Uploaded Provenance Actions
hatch_compile_yaml-18.0.0.tar.gz 4.6 kB Without provenance Details for hatch_compile_yaml-18.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hatch-compile-yaml 18.0.0
File Interpreter ABI Platform Actions
hatch_compile_yaml-18.0.0-py3-none-any.whl Python 3 none any Details for hatch_compile_yaml-18.0.0-py3-none-any.whl

Total release size: 8.8 kB

Release files / hatch_compile_yaml-18.0.0.tar.gz

Download URL hatch_compile_yaml-18.0.0.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8d9e98d7b90bb813df95333990643b21488ce1452e301823eaa313d85067133b
BLAKE2b-256 checksum
How to use checksums
6b458d2110774c35e7e7c1b464f43fb045fadb93321cb894bac6cdbe89aba593
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.27.0

Release files / hatch_compile_yaml-18.0.0-py3-none-any.whl

Download URL hatch_compile_yaml-18.0.0-py3-none-any.whl
Size 4.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0853b2ab4868522d05bbe591fd484b6f7d9b52b9fc57f19e51d081b70192bf7b
BLAKE2b-256 checksum
How to use checksums
333603b7ee2aa322d565fe3f566be3f4276b68145ca5ecaedfcae14ad88dcc4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.27.0

Security for hatch-compile-yaml 18.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page