HELML 0.1.8

Encoding-decoding HELML format

HELML

Python package

• HELML format definition (en)
• Описание формата HELML (ru)

Install

To install HELML, simply use pip:

pip install helml

Usage

from helml import HELML

# Example data structure
data = {
    "key1": "value1",
    "key2": [1, 2, 3],
    "key3": {
        "nested_key": "nested_value"
    }
}

# Encode the data structure into a HELML string
encoded_data = HELML.encode(data)
print(encoded_data)

# Decode the HELML string back into a data structure
decoded_data = HELML.decode(encoded_data)

encoded_data:

key1: value1

key2:
 :--:  1
 :--:  2
 :--:  3

key3
 :nested_key: nested_value

Features

Encode and decode data arrays to/from HELML.

API

HELML.encode(arr, url_mode=False)

Encode a data structure (list, dict, or tuple) into a HELML string.

• arr: The input data structure to be encoded.
• url_mode (bool, optional): A boolean indicating if the URL mode should be used. Defaults to False.

Returns:

• str: The encoded HELML string.

HELML.decode(src_rows)

Decode a HELML formatted string or list of strings into a nested dictionary.

• src_rows: The HELML input as a string

Returns:

• dict: The decoded nested dictionary.

See also:

• plugin "HELML" for Visual Studio Code
• Try online HELML plugin in vscode.dev