Metadata-Version: 2.5
Name: korml
Version: 0.3.1
Summary: A korml Parser and Emitter
Project-URL: Source, https://gitlab.com/ambhora/software/korml
Project-URL: Issues, https://github.com/ambhora/pykorml/issues
Author-email: Jayesh Badwaik <j.badwaik@fz-juelich.de>
License-Expression: Apache-2.0
Requires-Python: >=3.11
Description-Content-Type: text/markdown

<!--
- SPDX-License-Identifier: Apache-2.0
- Copyright (C) 2025 Jayesh Badwaik <j.badwaik@fz-juelich.de>
-->

# korml - Kosha's Reduced Markup Language


korml is the Python implementation of [Korml](https://ambhora.github.io/korml/),
a small, indentation-based markup language for configuration-like documents.
Its v0 form is a JSON-shaped, single-document strict subset of YAML, except
that a plain scalar may start with `&`, `*`, `!`, `%`, `@` or a backtick,
which YAML reads differently.

```python
import korml

assert korml.loads("name: example\n").to_builtin() == [{"name": "example"}]
```

Development uses [uv](https://docs.astral.sh/uv/):

```bash
uv sync
uv run pytest
uv run ruff check
CPDOCS_CURRENT_BRANCH=main uv run --group docs properdocs build --strict
```
