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 two 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.

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

# 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, 2 when already fresh, 1 on failure. Quiet by default.
--json Emit stable simplicio.mapper-index/v1 output for the index command.
--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.6.1.tar.gz (39.5 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.6.1-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simplicio_mapper-0.6.1.tar.gz
  • Upload date:
  • Size: 39.5 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.6.1.tar.gz
Algorithm Hash digest
SHA256 b93d6c8ef9589a0619da360733edb3448925ba9b574b71a30d3001210b2781ea
MD5 0adb12d836ad2eac6745479fee4a4b52
BLAKE2b-256 96fe05687b7a534e3342dbd4195b0e499bf709bce27b569e40789c0246431fd6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for simplicio_mapper-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 042e0cacca5159d6324713f6f8dbba5930efa59494043db0324212eaeadc1583
MD5 106b7c6f286dabcbf227e5d6b3ab2a66
BLAKE2b-256 a49336b34e1e660e9adc381545c8c576e6361edbec8a33ccbc7fbcb15b3cbe61

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