Skip to main content

Python Server Library for NOODLES Protocol

Project description

Rigatoni

Build Status PyPI Coverage badge

Python Server Library for NOODLES Protocol

Description

This server library implements the NOODLES messaging protocol and provides objects for maintaining a scene in state. The server uses a websocket connection to send CBOR encoded messages. To customize its implementation, the library provides convenient interface methods to assist the user in writing their own methods for the server. The user can also add custom delegates to add additional functionality to any of the standard components.

Documentation

For more information, check out the documentation.

Installation

Installation is as simple as:

pip install rigatoni

For optional dependencies and support for meshes and geometry object creation, you can install

pip install rigatoni[geometry]

Simple Example

import rigatoni as rig

class CustomTable(rig.Table):

    extra_info = None

    def handle_clear(self):
        print("Clearing table")

def basic_method(server, context):
    print("Hello World!")

starting_state = [
    rig.StartingComponent(rig.Method, {"name": "basic_method", "arg_doc": []}, basic_method),
]

delegates = {
    rig.Table: CustomTable
}

with rig.Server(50000, starting_state) as server:
    # do stuff
    pass

Hungry for more NOODLES?

For more information and other related repositories check out this collection

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

rigatoni-0.2.3.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

rigatoni-0.2.3-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file rigatoni-0.2.3.tar.gz.

File metadata

  • Download URL: rigatoni-0.2.3.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for rigatoni-0.2.3.tar.gz
Algorithm Hash digest
SHA256 88d25a306198b379fb6e31cb863b9f07022a6ab71f36035df55069734b7c791f
MD5 7843e058bb39955217f85cd821b2d590
BLAKE2b-256 ef0216a1f434e0115ef594234fdd8fe1bd3703075accf0f8f9d7447bd02e8d83

See more details on using hashes here.

Provenance

File details

Details for the file rigatoni-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: rigatoni-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for rigatoni-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7e504599fb1704387672205d0e162eaf82045b293fa9d2c86316d7d4e90872e3
MD5 ad0e33e8eb9ff37f5986fb3ae5f2b579
BLAKE2b-256 38c3566f4b7d2d019048a3d5e0ab6c70822883daf9e2bcee85a05595211e63c3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page