yini-parser 0.1.0a2

Official Python parser for YINI, an INI-inspired, indentation-insensitive configuration format with clear nested sections and explicit structure.

yini-parser-python

The official Python parser for YINI (by the YINI-lang project) — a human-readable, INI-inspired, indentation-insensitive configuration format with clear nested sections, explicit structure, comments, and predictable parsing.

Status: Alpha (0.1.0a1).
This parser is intended for early testing and integration. The public API and edge-case behavior may still change before 1.0.0.

---

Installation

Install from PyPI:

pip install yini-parser

The package name on PyPI is:

yini-parser

The Python import name is:

import yini_parser

---

Quick Start

Example YINI file:

// A small, practical YINI config.

// The App section starts here.
^ App
name = "Demo App"
version = 1.2
features = ["search", "logs"]
debug = false    // on/off, yes/no would work too.
pageSize = 25

    // Another section, nested under App.
    ^^ Server
    host = "localhost"
    port = 8080    # Can comment with # too.
    useTLS = off

Parse a YINI file:

from yini_parser import load

data = load("sample/basic.yini")

print(data["App"]["name"])  # Demo App
print(data["App"]["Server"]["port"])  # 8080

Parse a YINI string:

from yini_parser import loads

data = loads("""
^ App
name = "Demo App"
version = 1.2
debug = false
""")

print(data["App"]["name"])  # Demo App

Use load(...) to parse a file and loads(...) to parse a string.

See the YINI specification and documentation.

---

Examples

Runnable example projects are available in the YINI demo apps repository.

The Python examples show how to install yini-parser, load .yini files, and access parsed configuration data in small practical scripts.

• Python basic demo
• Python medium demo

---

Development

For local development:

python -m pip install -e ".[dev]"

or, if using the project Taskfile:

task install-dev

---

Tests

The tests/ directory contains a focused implementation-local test suite, including:

• Tests for the public API.
• Key semantic tests.
• Smoke/golden tests.
• Parser behavior tests for comments, values, sections, strict mode, conflicts, inline objects, and string concatenation.

Run the test suite with:

python -m pytest -v

or, if using the project Taskfile:

task test

Run the full project check with:

task check

---

Links

• YINI specification
• YINI homepage
• YINI-lang on GitHub
• yini-parser on PyPI

---

^YINI ≡

YINI is a human-readable, INI-inspired, indentation-insensitive configuration format with clear nested sections, explicit structure, and predictable parsing.

It has a formal specification and a defined grammar.

yini-lang.org · YINI-lang on GitHub