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 = trueRoadmap
Reference the open issues for a list of proposed features (and known issues).
Acknowledgements
Img Shields for making repository badges easy.
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-18.0.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8d9e98d7b90bb813df95333990643b21488ce1452e301823eaa313d85067133b |
|
| MD5 | c0ecba2a5d5eb9ab33848906b16f96bc |
|
| BLAKE2b-256 | 6b458d2110774c35e7e7c1b464f43fb045fadb93321cb894bac6cdbe89aba593 |
Hashes for hatch_compile_yaml-18.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0853b2ab4868522d05bbe591fd484b6f7d9b52b9fc57f19e51d081b70192bf7b |
|
| MD5 | 9cd52043fb33ac62360921a95e948350 |
|
| BLAKE2b-256 | 333603b7ee2aa322d565fe3f566be3f4276b68145ca5ecaedfcae14ad88dcc4c |
