Compile yaml files to msgpack
Project description
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
Img Shields for making repository badges easy.
Project details
Release history Release notifications | RSS feed
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
Hashes for hatch_compile_yaml-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da8977cd64a21bda30c9d4f23d7fec2a0b0389baaf6eff647aaafc370ca766fe |
|
MD5 | 79f5e1f8cac5f0aafd01cf5c2c265857 |
|
BLAKE2b-256 | 7dcff70180eab65389441ea71bb3a0b16c07897c7a64d672f93d7f7708152344 |