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.6.tar.gz (239.1 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.6-py3-none-any.whl (58.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spytial_diagramming-0.6.6.tar.gz
  • Upload date:
  • Size: 239.1 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.6.tar.gz
Algorithm Hash digest
SHA256 932aed08b9a7542303803bff410bbd248f072569828ffa6c94fff2a4fb9535d4
MD5 f191cad4f5e3df3d5cbb44171404df80
BLAKE2b-256 3b6a14588c34b0a857c8e2cfe619814d555e4aa9f77d2f926c521f13ae96aac2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spytial_diagramming-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3171950807e707c5b230c089206a94ecb6ce950a966713c740d23f9b1d2a8abd
MD5 4fb5918543e73c1fd0d514985560d6e3
BLAKE2b-256 25e69d1596447910b270fd8db3a8525b1dd35aa6896af277e0ee1d28b5915dbd

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