dpg-map/AGENTS.md

AGENTS.md

Current status

Step 1 complete.

Completed steps

Step 1 - Public API contract and pure core.

Current step

Step 2 - Thread-safe state, commands, overlays, and cache model.

Design decisions

• Package is managed with uv.
• Public import is import dpg_map as dpgm.
• Dear PyGui calls are GUI-thread-only.
• Runtime public calls enqueue commands or update logical state.
• Overlay updates must not reset center/zoom.
• The widget uses child_window + measured-size drawlist.
• Tiles use a memory cache and persistent disk cache.
• Tile providers are interchangeable.

Known issues

None yet.

Commands used

• Read STEPS.md, FEATURES.md, and ARCHITECTURE.md.
• Created initial package, examples, tests, and agent-log structure.
• Implemented public exports, exceptions, common types, tile provider registry, projection helpers, cache dataclasses, and GUI-dependent API stubs.
• Added Step 1 tests for imports, providers, projection, and cache dataclasses.
• Ran uv run pytest.
• Ran uv run ruff check ..
• Ran uv run ruff format --check ..
• Ran uv run pyright.

Next action

Implement Step 2.