https://github.com/matteosandrin/structoscope

Structoscope is a Python library for visualizing and inspecting any data structure.
https://github.com/matteosandrin/structoscope

arrays data-structures debugging maps python trees vizualisation

Last synced: about 7 hours ago
JSON representation

Structoscope is a Python library for visualizing and inspecting any data structure.

• Host: GitHub
• URL: https://github.com/matteosandrin/structoscope
• Owner: matteosandrin
• License: mit
• Created: 2020-09-10T22:55:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-22T12:11:00.000Z (over 5 years ago)
• Last Synced: 2026-01-03T08:08:05.829Z (3 months ago)
• Topics: arrays, data-structures, debugging, maps, python, trees, vizualisation
• Language: Python
• Homepage:
• Size: 235 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Structoscope

![License](https://img.shields.io/github/license/matteosandrin/structoscope)

![Python Version](https://img.shields.io/badge/python-3.8-blue)

![Build](https://img.shields.io/github/workflow/status/matteosandrin/structoscope/test/master)

![Coverage](https://img.shields.io/codecov/c/github/matteosandrin/structoscope/master)

![GitHub last commit](https://img.shields.io/github/last-commit/matteosandrin/structoscope)

![Documentation Status](https://readthedocs.org/projects/structoscope/badge/?version=latest)

Structoscope is a Python library for visualizing and inspecting any data structure.

## Install

The only external dependency is the `graphviz` binary, which you can install buy running the following command in the terminal.  

```

brew install graphviz

```

Now you can install structoscope by running the following command in the terminal.

```

pip3 install structoscope

```

## Documentation

You can find the documentation for this project [here](https://structoscope.readthedocs.io/en/latest/).

## Examples

### Lists

Structoscope can easily display Python lists:

```python

from structoscope import Scope

s = Scope()

testList = [1,2,3]

s.print(testList)

input() # block the main thread

```

![Example 1](example_01.png)

### Multi-dimensional Lists

It can even display multi-dimensional lists:

```python

from structoscope import Scope

s = Scope()

testList = [

    [1,2],

    [

        ['a', 'b'],

        ['c', 'd']

    ],

    'abc'

]

s.print(testList)

input() # block the main thread

```

![Example 2](example_02.png)

### Dictionaries

Or it can display dictionaries:

```python

from structoscope import Scope

s = Scope()

testDict = {

    'first' : 101,

    'second' : 102,

    'third' : 103,

}

s.print(testDict)

input() # block the main thread

```

![Example 3](example_03.png)

### Trees

It can even display trees:

```python

from structoscope import Scope

class Node:

    def __init__(self, val=None, children=[]):

        self.val = val

        self.children = children

s = Scope(

    dataMemberName='val',

    childrenMemberName='children'

)

node9 = Node(val='J')

node8 = Node(val='I')

node7 = Node(val='H')

node6 = Node(val='G')

node5 = Node(val='F')

node4 = Node(val='E')

node3 = Node(val='D', children=[node8, node9])

node2 = Node(val='C', children=[node6, node7])

node1 = Node(val='B', children=[node4, node5])

root = Node(val='A', children=[node1, node2, node3])

s.print(root)

input() # block the main thread

```

![Example 4](example_04.png)

## What's up with the name?

I think of it as a *stethoscope* whose purpose is to inspect a `struct`. A Struct-o-scope!