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.
1 maintainer
Metadata
1 maintainer
Release files for hatch-compile-yaml 18.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hatch_compile_yaml-18.0.0.tar.gz | 4.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hatch_compile_yaml-18.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.8 kB
Release files / hatch_compile_yaml-18.0.0.tar.gz
| Download URL | hatch_compile_yaml-18.0.0.tar.gz |
|---|---|
| Size | 4.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d9e98d7b90bb813df95333990643b21488ce1452e301823eaa313d85067133b
|
|
BLAKE2b-256 checksum How to use checksums |
6b458d2110774c35e7e7c1b464f43fb045fadb93321cb894bac6cdbe89aba593
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.27.0
|
Release files / hatch_compile_yaml-18.0.0-py3-none-any.whl
| Download URL | hatch_compile_yaml-18.0.0-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0853b2ab4868522d05bbe591fd484b6f7d9b52b9fc57f19e51d081b70192bf7b
|
|
BLAKE2b-256 checksum How to use checksums |
333603b7ee2aa322d565fe3f566be3f4276b68145ca5ecaedfcae14ad88dcc4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.27.0
|
