Laranex Schema Viewer
Framework-independent schema snapshots, an interactive ERD, and read-only MCP tools for SQLAlchemy 2.x, SQLModel, Django, Tortoise ORM, and Peewee. Inspired by Laravel Schema Viewer.
Build once from model definitions, then browse or query the saved JSON without starting your application or accessing its database. Foreign keys and declared ORM relationships remain separate throughout extraction, viewing, and MCP queries.
Quick start
Requires Python 3.10+. Install from PyPI in an isolated environment:
python3 -m venv .venv
source .venv/bin/activate
python -m pip install 'laranex-schema-viewer[sqlmodel,mcp]'
cd /absolute/path/to/application
laranex-schema-viewer init # optional: save defaults in pyproject.toml
laranex-schema-viewer build # finds your models package; writes schema-viewer.json
laranex-schema-viewer serve
Replace sqlmodel with your ORM's extra: sqlalchemy, django, tortoise, or peewee. In a Django project, build reads the settings module from manage.py.
With uv, add it to your application instead: uv add --dev 'laranex-schema-viewer[sqlmodel,mcp]', then prefix commands with uv run. The python3 bundled with macOS is 3.9 and is not supported; see installation.
Open http://127.0.0.1:8765 to search tables, inspect indexes and relationships, and navigate the graph. The viewer is the shared Laranex Schema Viewer UI, vendored prebuilt: it needs no Node.js or web framework and loads nothing from the internet.
Build only trusted modules: imports and mapper callbacks execute application code. Snapshots describe declared metadata, not deployed database state; review them before sharing.
Documentation
- Installation and quick start
- Supported ORMs: SQLAlchemy, SQLModel, Django, Tortoise ORM, Peewee, and model discovery
- CLI reference and interactive viewer
- MCP for Codex and Claude Code
- Agent skills and troubleshooting
Install agent skills with npx skills add laranex/python-schema-viewer; see the skills guide.
Contributing
See AGENTS.md for architecture, development commands, testing, and documentation maintenance. Validation and skill verification describe test coverage and limitations. Report vulnerabilities as described in SECURITY.md. Release notes are in the changelog.
Documentation Markdown lives in docs/; VitePress tooling lives in .gh-page/:
cd .gh-page
npm install
npm run dev -- --port 5173 --strictPort
Preview at http://127.0.0.1:5173/python-schema-viewer/.
License
1 maintainer
Metadata
1 maintainer
Release files for laranex-schema-viewer 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| laranex_schema_viewer-0.4.0.tar.gz | 1.1 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| laranex_schema_viewer-0.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.1 MB
Release files / laranex_schema_viewer-0.4.0.tar.gz
| Download URL | laranex_schema_viewer-0.4.0.tar.gz |
|---|---|
| Size | 1.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6976f1414a067bde55648f034f3405d8e2b7d29fa12f6f144588ad5ad837def2
|
|
BLAKE2b-256 checksum How to use checksums |
c9f6b9c2269da7de23b6181a470cdb9e76a573fe3f75423f7a791bb9cda30b7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logRelease files / laranex_schema_viewer-0.4.0-py3-none-any.whl
| Download URL | laranex_schema_viewer-0.4.0-py3-none-any.whl |
|---|---|
| Size | 976.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa5050d50312859fd9f5a507c82c559ca1cf8d9a9fbad96de67d4b2b8802c0b1
|
|
BLAKE2b-256 checksum How to use checksums |
ad70cd8b1af8d2cde755ae028bbd28f0e84ccc9a7d126ae23d29717451955ccb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logSecurity for laranex-schema-viewer 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for laranex_schema_viewer-0.4.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
