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-14.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3cb540c3f8ce73a3cc2527e7be4d46f8e4fb1f08fef88cbfe354cb7656e1485 |
|
MD5 | db931d724a7ca73a433111e5603b91ce |
|
BLAKE2b-256 | cab5e5425009ffd797a9c8b0912c8f287fe32934c7272953d403ef2d9a39478d |
Hashes for hatch_compile_yaml-14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 705fd505101716b9f6018b4021c7c92b6dcf8698be749290d8c2c493f0d1ba7e |
|
MD5 | 09555124a062baaf6d9cb1b2fc1c097e |
|
BLAKE2b-256 | bf98a2720682e1b8b7d5c6fa53732043c817df6c34ba89556992f64195f797fa |