Skip to main content

NyanCAD Python library for schematic editor with anywidget integration

Project description

NyanCAD Python Library

A Python library for the NyanCAD schematic editor with anywidget integration. Provides live access to schematic data from marimo notebooks.

Installation

pip install nyancad

Usage

Basic Usage

import marimo as mo
from nyancad import SchematicBridge

# Create a schematic bridge widget
bridge = SchematicBridge()

# Display the widget (shows connection status)
bridge

# Access live schematic data
print(bridge.schematic_data)

# Send simulation data back to the editor
bridge.simulation_data = {
    "results": [1.2, 3.4, 5.6],
    "timestamp": "2024-01-01T00:00:00Z"
}

Integration with Marimo

The SchematicBridge widget automatically connects to the NyanCAD editor running in the same marimo session. Any changes made in the schematic editor will be immediately reflected in the Python widget.

# In a marimo cell
bridge = SchematicBridge()
bridge  # This will show the connection status

# In another marimo cell - access the live data
mo.md(f"""
## Schematic Analysis
Raw schematic data: {len(bridge.schematic_data)} items
""")

# View the actual schematic data structure
bridge.schematic_data

Features

  • Live Sync: Real-time synchronization with NyanCAD schematic editor via PouchDB
  • Bidirectional Communication: Send simulation data back to the editor from Python
  • Zero Configuration: Automatically detects and connects to the active schematic
  • Raw Data Access: Direct access to the complete schematic data structure
  • Marimo Integration: Seamless integration with marimo notebooks

API Reference

SchematicBridge

The main widget class that provides bidirectional communication with the Mosaic editor.

Properties

  • schematic_data (dict): Raw schematic data from the Mosaic editor, automatically synced
  • simulation_data (dict): Simulation data to send to the Mosaic editor. Setting this will store the data with a timestamp in the editor's database

Development

This package is part of the NyanCAD project. The anywidget integration uses a ClojureScript bridge that compiles to an ESM module, allowing seamless data sharing between the schematic editor and Python environment.

License

This project is licensed under the Mozilla Public License 2.0 - 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

nyancad-0.4.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

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

nyancad-0.4.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file nyancad-0.4.0.tar.gz.

File metadata

  • Download URL: nyancad-0.4.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nyancad-0.4.0.tar.gz
Algorithm Hash digest
SHA256 304dd8c53984d1a86ce05a87c13e578a0f51797f1fed11351ca152abdb1b20fd
MD5 38bd687e5d8db86f81591b5041de8c5b
BLAKE2b-256 b9077f3ff15b0b1a92e005f1533b22f29200306258521fbfb05dfe022e8fc81a

See more details on using hashes here.

File details

Details for the file nyancad-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: nyancad-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nyancad-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 036fc09a1697957098da6bcfdc26539193532411fcbe7d9caabc42833bd92e3e
MD5 3e64b319e6d761f4e1f14f56bab1d80d
BLAKE2b-256 4844a5dced3d0e58af8ac73c7094af39348776d0cb1118bad3c9d741d3b81f95

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