json-toon


Namejson-toon JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryConvert JSON to TOON (Token-Oriented Object Notation) and back.
upload_time2025-11-06 08:43:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords json toon converter llm prompt
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # JSON Toon

Convert Python data structures to/from **TOON** (Token-Oriented Object Notation) - a lightweight, human-readable format optimized for LLM-friendly structured data.

## Installation

```bash
pip install json_toon
```

## What is TOON?

TOON is a Token-Oriented Object Notation format that represents structured data in a clean, readable way:
- Nested dictionaries with indentation
- Tables for lists of objects (using `|` separators)
- Comma-separated lists for simple arrays
- Human-readable and LLM-friendly

## Usage

### Convert Python Data to TOON Format

```python
from json_toon import json_to_toon

data = {
    "name": "Alice",
    "age": 30,
    "items": ["apple", "banana", "cherry"]
}

toon_string = json_to_toon(data)
print(toon_string)
# Output:
# name: Alice
# age: 30
# items:
#   apple, banana, cherry
```

### Convert TOON Back to Python Data

```python
from json_toon import toon_to_json

toon_text = """
name: Alice
age: 30
items:
  apple, banana, cherry
"""

data = toon_to_json(toon_text)
print(data)
# Output: {'name': 'Alice', 'age': 30, 'items': ['apple', 'banana', 'cherry']}
```

### Convert TOON to JSON String

```python
from json_toon import to_json_str

toon_text = """
name: Alice
age: 30
"""

json_string = to_json_str(toon_text)
print(json_string)
# Output: Pretty-printed JSON string
```

### Tables for Lists of Objects

```python
from json_toon import json_to_toon

users = [
    {"name": "Alice", "age": 30, "city": "NYC"},
    {"name": "Bob", "age": 25, "city": "LA"}
]

toon_string = json_to_toon(users)
print(toon_string)
# Output:
# name | age | city
# Alice | 30 | NYC
# Bob | 25 | LA
```

## API Reference

### `json_to_toon(data, indent=0)`
Convert Python object (dict, list, primitives) to TOON format string.

**Parameters:**
- `data`: Python object to convert
- `indent`: Starting indentation level (default: 0)

**Returns:** TOON-formatted string

### `toon_to_json(toon_text)`
Parse TOON-formatted text back into Python object.

**Parameters:**
- `toon_text`: TOON format string

**Returns:** Python object (dict, list, or primitive)

### `to_json_str(toon_text)`
Convert TOON text directly to JSON string.

**Parameters:**
- `toon_text`: TOON format string

**Returns:** Pretty-printed JSON string

## Development

To install in development mode:

```bash
pip install -e .
```

## License

MIT License - See LICENSE file for details.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "json-toon",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "json, toon, converter, llm, prompt",
    "author": null,
    "author_email": "Monish Meher <monishmeher@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/7c/06/e1eff214a73c3efad310bb52667dea80ba0bb0b8eb63d1a0da9f748b86d0/json_toon-1.0.1.tar.gz",
    "platform": null,
    "description": "# JSON Toon\n\nConvert Python data structures to/from **TOON** (Token-Oriented Object Notation) - a lightweight, human-readable format optimized for LLM-friendly structured data.\n\n## Installation\n\n```bash\npip install json_toon\n```\n\n## What is TOON?\n\nTOON is a Token-Oriented Object Notation format that represents structured data in a clean, readable way:\n- Nested dictionaries with indentation\n- Tables for lists of objects (using `|` separators)\n- Comma-separated lists for simple arrays\n- Human-readable and LLM-friendly\n\n## Usage\n\n### Convert Python Data to TOON Format\n\n```python\nfrom json_toon import json_to_toon\n\ndata = {\n    \"name\": \"Alice\",\n    \"age\": 30,\n    \"items\": [\"apple\", \"banana\", \"cherry\"]\n}\n\ntoon_string = json_to_toon(data)\nprint(toon_string)\n# Output:\n# name: Alice\n# age: 30\n# items:\n#   apple, banana, cherry\n```\n\n### Convert TOON Back to Python Data\n\n```python\nfrom json_toon import toon_to_json\n\ntoon_text = \"\"\"\nname: Alice\nage: 30\nitems:\n  apple, banana, cherry\n\"\"\"\n\ndata = toon_to_json(toon_text)\nprint(data)\n# Output: {'name': 'Alice', 'age': 30, 'items': ['apple', 'banana', 'cherry']}\n```\n\n### Convert TOON to JSON String\n\n```python\nfrom json_toon import to_json_str\n\ntoon_text = \"\"\"\nname: Alice\nage: 30\n\"\"\"\n\njson_string = to_json_str(toon_text)\nprint(json_string)\n# Output: Pretty-printed JSON string\n```\n\n### Tables for Lists of Objects\n\n```python\nfrom json_toon import json_to_toon\n\nusers = [\n    {\"name\": \"Alice\", \"age\": 30, \"city\": \"NYC\"},\n    {\"name\": \"Bob\", \"age\": 25, \"city\": \"LA\"}\n]\n\ntoon_string = json_to_toon(users)\nprint(toon_string)\n# Output:\n# name | age | city\n# Alice | 30 | NYC\n# Bob | 25 | LA\n```\n\n## API Reference\n\n### `json_to_toon(data, indent=0)`\nConvert Python object (dict, list, primitives) to TOON format string.\n\n**Parameters:**\n- `data`: Python object to convert\n- `indent`: Starting indentation level (default: 0)\n\n**Returns:** TOON-formatted string\n\n### `toon_to_json(toon_text)`\nParse TOON-formatted text back into Python object.\n\n**Parameters:**\n- `toon_text`: TOON format string\n\n**Returns:** Python object (dict, list, or primitive)\n\n### `to_json_str(toon_text)`\nConvert TOON text directly to JSON string.\n\n**Parameters:**\n- `toon_text`: TOON format string\n\n**Returns:** Pretty-printed JSON string\n\n## Development\n\nTo install in development mode:\n\n```bash\npip install -e .\n```\n\n## License\n\nMIT License - See LICENSE file for details.\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Convert JSON to TOON (Token-Oriented Object Notation) and back.",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/CatalystMonish/json_toon"
    },
    "split_keywords": [
        "json",
        " toon",
        " converter",
        " llm",
        " prompt"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "44396fb6cb2f8c63d89bef25305f53033c23f30ee366f9dbe9682b77936d11df",
                "md5": "b2bed59c5fa2eafdaa8f71adc18ec971",
                "sha256": "59b34c260e3103a08130279205bff33a7a0d7078d81bdc26305ef23694a84875"
            },
            "downloads": -1,
            "filename": "json_toon-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b2bed59c5fa2eafdaa8f71adc18ec971",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5935,
            "upload_time": "2025-11-06T08:43:41",
            "upload_time_iso_8601": "2025-11-06T08:43:41.604898Z",
            "url": "https://files.pythonhosted.org/packages/44/39/6fb6cb2f8c63d89bef25305f53033c23f30ee366f9dbe9682b77936d11df/json_toon-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7c06e1eff214a73c3efad310bb52667dea80ba0bb0b8eb63d1a0da9f748b86d0",
                "md5": "ef632f1deec93da8faf268247f539780",
                "sha256": "5e5460b54c43f3790d489ff20c26d6b8eefc534fd0f180389171da7d57a8189a"
            },
            "downloads": -1,
            "filename": "json_toon-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ef632f1deec93da8faf268247f539780",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5396,
            "upload_time": "2025-11-06T08:43:42",
            "upload_time_iso_8601": "2025-11-06T08:43:42.682121Z",
            "url": "https://files.pythonhosted.org/packages/7c/06/e1eff214a73c3efad310bb52667dea80ba0bb0b8eb63d1a0da9f748b86d0/json_toon-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-06 08:43:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CatalystMonish",
    "github_project": "json_toon",
    "github_not_found": true,
    "lcname": "json-toon"
}
        
Elapsed time: 4.70085s