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.8.tar.gz (31.9 kB view details)

Uploaded Source

Built Distribution

rigatoni-0.2.8-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rigatoni-0.2.8.tar.gz
Algorithm Hash digest
SHA256 363d49e69bb01737950587044bbb9c7fddce8e6176adf387ef87c74a80ddb3f1
MD5 fc3e4db3afce22662e199985c088d2cb
BLAKE2b-256 e046440317e4cf25019b3e5831da20d432082dc0cc7db4e77624b4cee836f9e7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rigatoni-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 82b8c64bc1a7a9e9be1fe72e176514bfd3f3e19b874fd98aa10af4d55e347b7d
MD5 2d6421026f0fd568dc4f8178a435f96a
BLAKE2b-256 b642b58357d848fd482ca0b6925cffeb47ad54a8d18736bdddc8dbfa01956f34

See more details on using hashes here.

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