Skip to main content

Python-first project mapper that emits .simplicio/project-map.json and precedent-index.json for the Simplicio ecosystem.

Project description

simplicio-mapper

Python-first project mapper for the Simplicio ecosystem. It scans a repository and emits machine-readable artifacts that agents and tooling can consume without parsing the human-readable markdown docs:

  • .simplicio/project-map.json (simplicio.project-map/v1) — file inventory, architecture signals, entry points, tests, modules, entities, dependencies and recent changes.
  • .simplicio/precedent-index.json (simplicio.precedent-index/v1) — high-signal code examples tagged by change type, file, language, roles and snippet.
  • .simplicio/architecture-inventory.json (simplicio.architecture-inventory/v1) — modules, layers, responsibilities, evidence pointers, tests, symbols and relationships.
  • .simplicio/symbol-index.json (simplicio.symbol-index/v1) — detected classes, functions, methods and exports with file/line evidence.
  • .simplicio/call-graph.json (simplicio.call-graph/v1) — import and heuristic caller/callee relationships with confidence scores.

The full contract is documented in SIMPLICIO_INTEGRATION.md.

Install

Requires Python 3.10+. The package installs lightweight performance dependencies (orjson for JSON serialization and diskcache for persistent file-processing cache).

pip install simplicio-mapper

Usage

# Map the current directory into .simplicio/
simplicio-mapper map

# Refresh artifacts and record changed files since the last run
simplicio-mapper update

# Idempotent orchestration entry point for SendSprint and other runners
simplicio-mapper index path/to/project --json
simplicio-mapper index --update path/to/project --json

# Compare frontend/API-client calls against runtime server routes
simplicio-mapper endpoints path/to/web --against path/to/api --json

# Render architecture inventory markdown for wiki/docs review
simplicio-mapper docs path/to/project --json
simplicio-mapper export-docs path/to/project --target ./wiki-export --json

# Map another project root, with hints when .starter-meta.json is absent
simplicio-mapper map --root path/to/project --stack python --product-name "My App"

# Re-run automatically while files change locally
simplicio-mapper map --watch

The llm-project-mapper console script is provided as an alias.

Options

Option Description
index <path> Scriptable index command. Returns 0 when refreshed or already fresh, 1 on failure. Quiet by default.
endpoints <path> Extract normalized client calls and server routes, including Python API clients, direct page-level Python calls and Angular HttpClient services. Use --against <server-root> to report missing_from_server with source files using schema simplicio.endpoint-inventory/v1.
docs <path> Render architecture inventory Markdown under .simplicio/docs/.
export-docs <path> Copy rendered Markdown docs to a local target directory. Remote publication is intentionally opt-in and not automatic.
--against <dir> Server/API project root for endpoint comparison.
--target <dir> Local target directory for export-docs.
--docs Render Markdown docs after map or index.
--no-docs Keep map/index JSON-only.
--json Emit stable simplicio.mapper-index/v1 output for the index command.
--update Compatibility alias for index refresh workflows.
--verbose Show progress during index refreshes.
--root <dir> Project root to map. Defaults to the current directory.
--out <dir> Artifact directory. Defaults to .simplicio.
--stack <name> Stack hint when .starter-meta.json is absent.
--product-name <name> Product name hint when .starter-meta.json is absent.
--incremental Record changed files and update existing artifacts.
--watch Re-run mapping when local files change.
--silent Minimal output.
-V, --version Show version and exit.
-h, --help Show help.

Consuming the artifacts

from pathlib import Path
import json

base = Path(".simplicio")
project_map = json.loads((base / "project-map.json").read_text())
precedents = json.loads((base / "precedent-index.json").read_text())

top_files = sorted(
    project_map["files"], key=lambda f: f.get("importance", 0), reverse=True
)[:8]

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simplicio_mapper-0.7.0.tar.gz (54.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simplicio_mapper-0.7.0-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

Details for the file simplicio_mapper-0.7.0.tar.gz.

File metadata

  • Download URL: simplicio_mapper-0.7.0.tar.gz
  • Upload date:
  • Size: 54.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for simplicio_mapper-0.7.0.tar.gz
Algorithm Hash digest
SHA256 afd5842f872c220bbaaddb00e8c78a1d834c5b50ee7efc4c0b5de8059d067bcb
MD5 84c3ecaddc2defde68c101c6c646af70
BLAKE2b-256 3a523a9620cda97fe884c002d42daad533cf8a3eb3ad3caf32ac4d3caca58025

See more details on using hashes here.

File details

Details for the file simplicio_mapper-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simplicio_mapper-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f67f30961ffce080136900b33f61dbfe6674f46a9b03c064d1cc750acd6d65fe
MD5 67d198fb74b425ba575ae393351e13dd
BLAKE2b-256 9bb8873e2a84e43f130259345fbfd676bfa88869a3c584c9581ca877e69e935e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page