Skip to main content

sPyTial: Spatial Python visualization with declarative constraints

Project description

sPyTial: Lightweight Diagrams for Structured Python Data

PyPI version Python versions License: MIT CI Docs

pip install spytial-diagramming

Docs: https://sidprasad.github.io/spytial/ — start with Getting Started for install, badges, and your first diagram.


Sometimes you just want to see your data.

You're working with a tree, a graph, a recursive object — maybe an AST, a neural network, or a symbolic term. You don't need an interactive dashboard or a production-grade visualization system. You just need a diagram that lays it out clearly so you can understand what's going on.

That's what sPyTial is for. It is designed for developers, educators, and researchers who work with structured data and need to make that structure visible — to themselves or to others — with minimal effort.

Why spatial layout

Spatial arrangement helps people understand structure: when elements are grouped, aligned, and oriented meaningfully, patterns and errors become easier to see. sPyTial gives you that layout by default — the diagram reflects how the parts are connected, not how they happen to be stored.

You get:

  • a box-and-arrow diagram that shows the shape of your data
  • a layout driven by declarative constraints (orientation, align, cyclic, group)
  • a tool that flags when a constraint can't be satisfied

Quick start

import spytial

data = {
    "name": "root",
    "children": [
        {"value": 1},
        {"value": 2},
        {"value": 3},
    ],
}

# Opens in a browser tab, or inline in a Jupyter notebook.
spytial.diagram(data)

# Or save to a file:
spytial.diagram(data, method="file")

Not sure where to start with a class of your own? from spytial.suggest import suggest then suggest(MyClass) reads the class and scaffolds a starting set of layout directives you can edit — see Suggesting Specs.

For stepping through sequences of states, custom relationalizers, and annotation-driven layouts, see the docs.

Related projects

  • spytial-clrs — a Jupyter notebook collection that implements the data structures from the CLRS algorithms textbook (Cormen, Leiserson, Rivest, Stein) using sPyTial: heaps, linked lists, hash tables, BST / red-black / B / van Emde Boas trees, disjoint-set forests, graphs with MST and SCC views, and more. The best place to see sPyTial on realistic structures.
  • spytial-core — the browser-side rendering engine sPyTial uses under the hood. Shared across all sPyTial language hosts (Python, Rust, Pyret, Lean).

License

MIT — see LICENSE.

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

spytial_diagramming-1.6.1.tar.gz (510.8 kB view details)

Uploaded Source

Built Distribution

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

spytial_diagramming-1.6.1-py3-none-any.whl (320.5 kB view details)

Uploaded Python 3

File details

Details for the file spytial_diagramming-1.6.1.tar.gz.

File metadata

  • Download URL: spytial_diagramming-1.6.1.tar.gz
  • Upload date:
  • Size: 510.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for spytial_diagramming-1.6.1.tar.gz
Algorithm Hash digest
SHA256 da7ee23f980b2b343af8a1c4583ba53b6d19606b3d3d7854522df4c0c6f77b1a
MD5 4754974847b0cbd57bfdc767ab97bf15
BLAKE2b-256 7510a3f9ba0eb925cd2a32145fe6757c8bd5b62ca3beef78da3511b024fd96fb

See more details on using hashes here.

File details

Details for the file spytial_diagramming-1.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for spytial_diagramming-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2615efdd3e9159066c27eed2771e6922268724047ea4340abead9d46818cca8
MD5 c3a4634fa88b03ea39241f507e1356a6
BLAKE2b-256 37f9d38d7bd576cecf4b15659ebd7d5f417da6ddc0a896afa18245db53366fb2

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