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
File details
Details for the file hatch_compile_yaml-2.0.0.tar.gz.
File metadata
- Download URL: hatch_compile_yaml-2.0.0.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1606a43d0a05b519575599aa6c494cc66f27bda41bf4bcc63c017ed16ea76ad9 |
|
| MD5 | 423d3ccde94512a83a54431ff56a6ecc |
|
| BLAKE2b-256 | 7e7289bc6442df981cc4ae86dfd032f917a0f57aa8de4d7e2618a33496434edf |
File details
Details for the file hatch_compile_yaml-2.0.0-py3-none-any.whl.
File metadata
- Download URL: hatch_compile_yaml-2.0.0-py3-none-any.whl
- Upload date:
- Size: 4.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e6c884f229892f80f63d57648da0a9b1595457db47fd15a95e68451bf8981653 |
|
| MD5 | b850d776464dc4a97b75273192017783 |
|
| BLAKE2b-256 | e7097ce884ad49148364696081c6b1412239e368cfd9dfd77fdc51fa4a5cf3bf |
