TinyObj documentation

Contents:

• Tutorial: Getting Started with TinyObj
  • Syntax Basics
    • Basic comments
    • Basic Object
    • Nested Objects
    • Lists and Collections
  • Using the Python API
    • Loading TinyObj
    • Serializing to TinyObj
  • Handling Errors
  • Common Data Types
  • Next Steps
• API Reference
  • tobj
    • Submodules
      • tobj.errors
      • tobj.interpreter
      • tobj.lexer
      • tobj.main
      • tobj.parser
    • Functions
    • Package Contents
      • loads()
      • load()
      • dumps()
      • dump()

TinyObj is a minimal, human-readable object notation designed for configuration, data exchange, and structured text. It uses simple sigils to define objects (*), properties (>), and lists (-), making it easy to write by hand and parse programmatically.

*User
  > name    "Alice"
  > age     30
  > tags
     - python
     - rust

*User.profile
  > active    true
  > score     9001

Key features:

• Hierarchical objects via dot-separated paths (e.g., *User.profile)

• Typed values: strings, numbers, booleans, nothing (null), and lists

• Clean, indentation-free syntax

• Built-in error reporting with source positions and visual highlights

• Bi-directional: parse to Python dict, serialize back to TinyObj

This documentation includes:

• A tutorial for getting started

• A full api/tobj reference for developers

• Examples and best practices for real-world usage

Get started by installing TinyObj:

pip install tobj

Then use it in Python:

import tobj
data = tobj.loads("*Config >debug true")
print(data)  # {'Config': {'debug': True}}

Check out the TOBJ repository on GitHub for source code, examples, and more information. It’s also online on PyPI: https://pypi.org/project/tobj/.