| Name | penne JSON |
| Version |
0.5.5
JSON |
| download |
| home_page | |
| Summary | Python Client Library for NOODLES Protocol |
| upload_time | 2023-08-24 20:13:10 |
| maintainer | |
| docs_url | None |
| author | Alex Racapé |
| requires_python | >=3.9 |
| license | |
| keywords |
noodles
cbor
websockets
client
noodles
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Penne
[](https://htmlpreview.github.io/?https://github.com/InsightCenterNoodles/Penne/blob/python-coverage-comment-action-data/htmlcov/index.html)
Python Client Library for NOODLES Protocol
## Description
Penne is the first client library to implement the NOODLES messaging protocol in Python. NOODLES allows multiple client
applications to interact collaboratively with data in real-time. The client uses a websocket connection to send CBOR
encoded messages, and all components in the scene graph can be subclassed and customized to fit an application's
needs.
## Documentation
For more information, check out [the documentation](https://insightcenternoodles.github.io/Penne/).
## Installation
Installation is as simple as:
```bash
pip install penne
```
## Simple Example
```python
from penne import Method, Client
class CustomMethod(Method):
custom_attribute = None
def on_new(self, message: dict):
print(f"New method named {self.name} was created")
with Client("ws://localhost:50000", {Method: CustomMethod}) as client:
# do stuff
```
## Hungry for more NOODLES?
For more information and other related repositories check out [this collection](https://github.com/InsightCenterNoodles)
Raw data
{
"_id": null,
"home_page": "",
"name": "penne",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "noodles,cbor,Websockets,client,NOODLES",
"author": "Alex Racap\u00e9",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/29/95/ab10ac6db18f676009fe6f3519bceb23c05d3dce65b9f94a472a7bfec2ac/penne-0.5.5.tar.gz",
"platform": null,
"description": "# Penne\n\n\n\n[](https://htmlpreview.github.io/?https://github.com/InsightCenterNoodles/Penne/blob/python-coverage-comment-action-data/htmlcov/index.html)\n\nPython Client Library for NOODLES Protocol\n\n## Description\nPenne is the first client library to implement the NOODLES messaging protocol in Python. NOODLES allows multiple client\napplications to interact collaboratively with data in real-time. The client uses a websocket connection to send CBOR \nencoded messages, and all components in the scene graph can be subclassed and customized to fit an application's \nneeds. \n\n## Documentation\n\nFor more information, check out [the documentation](https://insightcenternoodles.github.io/Penne/).\n\n\n## Installation\n\nInstallation is as simple as:\n\n```bash\npip install penne\n```\n\n## Simple Example\n\n```python\nfrom penne import Method, Client\n\n\nclass CustomMethod(Method):\n \n custom_attribute = None\n \n def on_new(self, message: dict):\n print(f\"New method named {self.name} was created\")\n \n \nwith Client(\"ws://localhost:50000\", {Method: CustomMethod}) as client:\n # do stuff\n\n```\n\n## Hungry for more NOODLES?\nFor more information and other related repositories check out [this collection](https://github.com/InsightCenterNoodles)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python Client Library for NOODLES Protocol",
"version": "0.5.5",
"project_urls": {
"Documentation": "https://insightcenternoodles.github.io/Penne/",
"Source": "https://github.com/InsightCenterNoodles/Penne"
},
"split_keywords": [
"noodles",
"cbor",
"websockets",
"client",
"noodles"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40bb37b444176f9dc0978e19d55ca19737a85bdc49354b9702ac74a4a216de20",
"md5": "60113a7fe3e0ec3a377cb473d8b47528",
"sha256": "7d5df63e2e5c3c7946660525d5567f0abb6134353ae57ae4c6be24de1ed70fd5"
},
"downloads": -1,
"filename": "penne-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60113a7fe3e0ec3a377cb473d8b47528",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20142,
"upload_time": "2023-08-24T20:13:08",
"upload_time_iso_8601": "2023-08-24T20:13:08.731666Z",
"url": "https://files.pythonhosted.org/packages/40/bb/37b444176f9dc0978e19d55ca19737a85bdc49354b9702ac74a4a216de20/penne-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2995ab10ac6db18f676009fe6f3519bceb23c05d3dce65b9f94a472a7bfec2ac",
"md5": "677902e229d932d906d9b9b26710b644",
"sha256": "35b938b9c17dfd5050311672dafd46db11318c5c7606c73b5894760ea1a0cfb7"
},
"downloads": -1,
"filename": "penne-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "677902e229d932d906d9b9b26710b644",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19349,
"upload_time": "2023-08-24T20:13:10",
"upload_time_iso_8601": "2023-08-24T20:13:10.251196Z",
"url": "https://files.pythonhosted.org/packages/29/95/ab10ac6db18f676009fe6f3519bceb23c05d3dce65b9f94a472a7bfec2ac/penne-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-24 20:13:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "InsightCenterNoodles",
"github_project": "Penne",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "penne"
}
