kubiks 0.1.2

A simple library that allows you to work with .kbk files.

A simple and human-readable configuration language for Python.

🇺🇸 English | 🇷🇺 Русский

Introduction

Kubiks is a lightweight and human-readable configuration format for Python.

It was created as a more convenient alternative to JSON for situations where configuration files need to be edited manually. The syntax remains simple while supporting nested structures, lists, percentages, comments, and other useful features.

Features

• ✨ Clean and readable syntax
• 📦 Support for nested objects and lists
• 💬 Comments directly inside configuration files
• 📊 Automatic percentage conversion
• 🔢 Integer and floating-point numbers
• ✅ Boolean values (true / false)
• ⭕ null values
• 🐍 Easy integration with Python

For example, the following file:

player |= {
    username |= "KubikNoLego"
    level |= 42
    premium |= true
    win_rate |= 67%
}

Will be loaded as a regular Python dictionary:

{
    "player": {
        "username": "KubikNoLego",
        "level": 42,
        "premium": True,
        "win_rate": 0.67
    }
}

Loading a File

from kubiks import load

config = load("config.kbk")

The load() function returns a standard Python dictionary that can be used anywhere in your application.

Writing .kbk Files

All data is stored using a key-value format.

The assignment operator is |=:

name |= "Kubik"

After loading:

{
    "name": "Kubik"
}

Supported Data Types

Strings

Kubiks:

name |= "Kubik"

Python:

{
    "name": "Kubik"
}

---

Null

Kubiks:

title |= null

Python:

{
    "title": None
}

---

Integers

Kubiks:

some_number |= -20

Python:

{
    "some_number": -20
}

---

Floating-Point Numbers

Kubiks:

price |= 19.99

Python:

{
    "price": 19.99
}

---

Boolean Values

Kubiks:

enabled |= true
admin |= false

Python:

{
    "enabled": True,
    "admin": False
}

---

Percentages

Kubiks:

win_rate |= 67%
tax |= 20%

Python:

{
    "win_rate": 0.67,
    "tax": 0.2
}

Percentages are automatically converted into decimal values.

---

Lists

Kubiks:

inventory |= [
    "wooden_sword",
    "iron_pickaxe",
    "golden_apple"
]

Python:

{
    "inventory": [
        "wooden_sword",
        "iron_pickaxe",
        "golden_apple"
    ]
}

---

Objects

Kubiks supports nested structures of any depth.

user |= {
    username |= "KubikNoLego"

    statistics |= {
        games_played |= 156
        games_won |= 104
    }
}

Python:

{
    "user": {
        "username": "KubikNoLego",
        "statistics": {
            "games_played": 156,
            "games_won": 104
        }
    }
}

---

Comments

Comments start with the # character.

# User settings
theme |= "dark"

# Enable notifications
notifications |= true

Comments are ignored when loading the file.

---

License

This project is licensed under the MIT License.