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

Uploaded Source

Built Distribution

rigatoni-0.2.6-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rigatoni-0.2.6.tar.gz
  • Upload date:
  • Size: 30.7 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.6.tar.gz
Algorithm Hash digest
SHA256 6d4ef175bcf4099d9e1a9a74e79f07a3053a6e6d2b805bd0e2112d4ef5df2f8d
MD5 2e5a18b1f5d74788b44379858edf6c4b
BLAKE2b-256 7c7bfa847a7c90d67aec37b26664603132a868ac216b51cc57269aba73326880

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: rigatoni-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 32.6 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7e142a41b406c1d6711b88aa0029441e50f754f9f33d45996c89b0fcd14ccecb
MD5 bc1df9ba55963370858cfd804da5df55
BLAKE2b-256 f941a705c02a39911124b88066790bea24bd4e75dd6470f6d834de3a8b4a7b2c

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