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-11.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e73a427de7333509639c4e554ce34084dbafd8b6c41465e96cd30dcbd481682 |
|
MD5 | 640529d2e16a4d64515a41163efa180b |
|
BLAKE2b-256 | 0bbce64fcb0a098b45846e1b61de0995c4957719499f3bc68500c3e6593a6cad |
Hashes for hatch_compile_yaml-11.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad8dc8320d67eb6092121ee707104698cd337189af0dee33e44bfafa2a87c31a |
|
MD5 | 4330616b7bff7ece6dd0b904b9ebe818 |
|
BLAKE2b-256 | 0b44091bf1fad301e1154ff7cd408f0de166b8d15315ceb6449244d43327dfa2 |