Guide

This guide walks you through ndict-tools from first use to advanced extension patterns. It is organised as four progressive parts — read them in order or jump directly to the section you need.

• Part 1 — Getting Started
  • Installation
  • Creating a nested dictionary
  • Reading, writing, and deleting
  • Searching across all levels
  • Choosing the right variant
• Part 2 — Working with Paths
  • Listing all paths
  • Navigating parent–child relationships
  • Filtering paths
  • Searching by key name
  • Working with compact paths
  • Checking coverage
• Part 3 — Serialisation
  • JSON round-trip
  • Pickle round-trip
  • JSON vs pickle — when to use which
• Part 4 — Extending the Package
  • The private/public split
  • The default_setup contract
  • The from_dict recursion pattern
  • The _HKey tree model
  • Writing a custom path filter
  • Writing a custom subclass

If you are looking for definitions and mental models rather than usage recipes, start with the Concepts section first.