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

Uploaded Python 3

File details

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

File metadata

  • Download URL: spytial_diagramming-0.6.7.tar.gz
  • Upload date:
  • Size: 239.3 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.7.tar.gz
Algorithm Hash digest
SHA256 e5dd95c3592ee3acaacc53457a02ea0622e02a1d653fd6364e7a1a98d667dc2f
MD5 25b7911f6785912814fa26b71b2d1e09
BLAKE2b-256 06b5d5b10ca0bf186515c3f4223b98f5db26c58f118fcf71658f319a349237e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spytial_diagramming-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 681569fc076cfd3790ab3cc7c640f18eee7983686ff80b4c18112ec5bb166d8b
MD5 e9c0e466475b87aba777bb215d3ab323
BLAKE2b-256 e3a2d275888971d86554c47b5a284e52ff4a03800c2268c80f0ad5f8e6c7a477

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