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-16.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67fcc010e84e13dae1ae2c8a2eb1b6fb39001a91ca74ce3f7167278187c8a155 |
|
MD5 | 38162e827743b3c44e2890cc3551432b |
|
BLAKE2b-256 | 4fa34646d02f5041427de40546d9fc5c26fb0f5d41178f7c8a76e3050db18d54 |
Hashes for hatch_compile_yaml-16.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03e18728ee5ac471682bc1bad8fc2a71b0773027a0b71a0e07bd44430706d491 |
|
MD5 | b1965a68aebe68fc951a10e8c26773da |
|
BLAKE2b-256 | 569b27aec32244b4514cbfb1ec31099b3171704f3a5b69824392301f65ba0b0a |