dictIO Documentation

Contents:

• dictIO
  • Installation
  • Usage Example
  • File Format
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Activate the virtual environment
    • 6. Install pre-commit hooks
    • 7. Test that the installation works
  • Meta
  • Contributing
• API Reference
  • dictIO package
    • Subpackages
      • dictIO.utils
    • Modules
      • dictIO.dict
      • dictIO.dict_parser
      • dictIO.dict_reader
      • dictIO.dict_writer
      • dictIO.formatter
      • dictIO.parser
      • dictIO.types
      • dictIO.cpp_dict
• CLI Documentation
  • dictParser - CLI interface
    • dictParser positional arguments
    • dictParser options
• File Format
  • dict
    • Description
    • Structure
    • Header
    • #include Directive(s)
    • Element Types
    • Examples
      • booleans
      • numbers
      • nones
      • strings
      • dicts
      • lists
    • References and Expressions
    • Nesting
    • The dict-in-a-list Pitfall
• Changelog
  • Unreleased
  • 0.4.1 - 2025-01-18
    • Added
    • Solved
    • Dependencies
  • 0.4.0 - 2024-11-11
    • Breaking changes
    • Changed
    • Solved
    • Added
    • GitHub workflows
    • Dependencies
  • 0.3.4 - 2024-05-22
    • Dependencies
    • Changed
  • 0.3.3 - 2024-02-21
    • Hotfix
  • 0.3.2 - 2024-02-21
    • Added
    • Removed
    • Changed
    • Dependencies
  • 0.3.1 - 2024-01-09
    • Solved
  • 0.3.0 - 2024-01-08
    • Changed
    • Dependencies
  • 0.2.9 - 2023-09-20
    • Dependencies
  • 0.2.8 - 2023-06-22
    • Changed
    • Dependencies
  • 0.2.7 - 2023-05-04
    • Changed
  • 0.2.6 - 2023-01-11
    • Changed
  • 0.2.5 - 2023-01-04
    • Changed
    • Added
  • 0.2.4 - 2022-12-12
    • Changed
    • Added
  • 0.2.3 - 2022-12-01
    • Changed
    • Added
  • 0.2.2 - 2022-11-08
    • Added
  • 0.2.1 - 2022-10-13
    • Solved
  • 0.2.0 - 2022-09-29
    • Added
    • Changed
    • Removed
  • 0.1.2 - 2022-09-27
    • Solved
  • 0.1.1 - 2022-08-19
    • Added
  • 0.1.0 - 2022-05-28
    • Changed
  • 0.0.22 - 2022-05-09
  • 0.0.17 - 2022-02-14
    • Added
• Style Guide
  • References
  • Code Layout
  • Line Breaks
  • String Formatting
  • Naming Conventions
  • Named Arguments
  • Commenting
  • Type hints
  • Docstrings
  • Exceptions
  • Imports
  • Unit-tests
  • And finally: It is a bad idea to use
• LICENSE

Indices and tables

• Index

• Module Index

• Search Page