Skip to main content

Compile yaml files to msgpack

Project description

Made with Python

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.yaml-compile.options]
pattern = "*.yaml"
remove_source_files = True

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hatch_compile_yaml-1.0.0.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

hatch_compile_yaml-1.0.0-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file hatch_compile_yaml-1.0.0.tar.gz.

File metadata

  • Download URL: hatch_compile_yaml-1.0.0.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for hatch_compile_yaml-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8adfcd07a866146ffe27485083323df43f9f073c8ee6aac40bd3706023e0d2a8
MD5 5d5273ff42a9b77678d961627b220ef9
BLAKE2b-256 23431eb8aafdb9ea126ad5ae7606fefa12def7c81b519a5d0430467d720360c4

See more details on using hashes here.

File details

Details for the file hatch_compile_yaml-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hatch_compile_yaml-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0872e08132a0e7563db047622dcc0a039cb4830e80ca286cc6088d23fc732503
MD5 8385612e751e37170a0f7cca40af6a8b
BLAKE2b-256 8afa747e841e1c93cc276645eacd099c467b4b6cfe570618af238fb35606de82

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page