Skip to main content

sPyTial: Spatial Python visualization with declarative constraints

Project description

sPyTial: Lightweight Diagrams for Structured Python Data

pip install spytial-diagramming

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, something that lays it out clearly so you can understand what’s going on.

That’s what sPyTial is for. It’s 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 Representation Matters

There’s strong evidence — from cognitive science, human-computer interaction, and decades of programming tool design — that spatial representations help people understand structure. When elements are placed meaningfully in space — grouped, aligned, oriented — we can spot patterns, detect errors, and reason more effectively. This idea shows up in research from Barbara Tversky, Larkin & Simon, and in the design of tools like Alloy and Scratch.

sPyTial gives you that kind of spatial layout by default. When you visualize a Python object, the diagram reflects how the parts are connected, not just how they're stored. You get:

  • A box-and-arrow diagram that shows the shape of your data
  • A layout that follows cognitive and structural conventions
  • A tool that knows when something doesn't make sense

Quick Start

import spytial

# Visualize any Python object
data = {
    'name': 'root',
    'children': [
        {'value': 1},
        {'value': 2},
        {'value': 3}
    ]
}

# Opens in browser or inline if in a jupyter notebook.
spytial.diagram(data)

# Or save to file
spytial.diagram(data, method='file')

Documentation

User-facing documentation is available at https://sidprasad.github.io/spytial/ and is generated with MkDocs from the codebase and Markdown guides.

License

This project is licensed under the MIT License. See the LICENSE file for details.

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-0.6.3.tar.gz (226.9 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-0.6.3-py3-none-any.whl (57.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spytial_diagramming-0.6.3.tar.gz
  • Upload date:
  • Size: 226.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for spytial_diagramming-0.6.3.tar.gz
Algorithm Hash digest
SHA256 4f62387223292929e305145c1e6e5cd5377f31abfcb7c228368c76cab6190ebb
MD5 a3696d65c028b3f29d4d147270d8866f
BLAKE2b-256 6fdfc93c3b5bf58c4c1c672e6b804300289b9b85efd19205492de0cb31c143ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spytial_diagramming-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b59381c5e1bc4d6c1242f501c33c1fc88a150688dc02d2dd817580ebaf4b45b6
MD5 6becea92ac9d38e87b846ec5b766a06e
BLAKE2b-256 3ef918abd5a21c11c91a4240d397b3e56a1c548223676f7aa5543f01b2798f93

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