| Name | vo-wot JSON |
| Version |
0.18.12
JSON |
| download |
| home_page | None |
| Summary | Virtual Object python implementation using a W3C WoT Runtime and the WoT Scripting API |
| upload_time | 2024-11-12 14:29:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 National Technical University of Athens Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
wot
iot
gateway
fog
w3c
vo
virtual object
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# VO-WoT
This repository is based on the Web of Things Python implementation [WoTPy](https://github.com/agmangas/wot-py).
[](https://pypi.org/project/vo-wot/)
## Introduction
This repository is a fork of the original [WoTPy](https://github.com/agmangas/wot-py) repository.
VO-WoT is an experimental implementation of a [W3C WoT Runtime](https://github.com/w3c/wot-architecture/blob/master/proposals/terminology.md#wot-runtime) and the [W3C WoT Scripting API](https://github.com/w3c/wot-architecture/blob/master/proposals/terminology.md#scripting-api) in Python.
Inspired by the exploratory implementations located in the [Eclipse thingweb GitHub page](https://github.com/eclipse-thingweb/).
## Features
- Supports Python 3 with versions >= 3.8
- Fully-implemented `WoT` interface.
- Asynchronous I/O programming model based on coroutines.
- Multiple client and server [Protocol Binding](https://github.com/w3c/wot-architecture/blob/master/proposals/terminology.md#protocol-binding) implementations.
### Feature support matrix
| Feature | Python 3 | Implementation based on |
| -----------------: | ------------------ | ----------------------------------------------------------------------- |
| HTTP binding | :heavy_check_mark: | [tornadoweb/tornado](https://github.com/tornadoweb/tornado) |
| WebSockets binding | :heavy_check_mark: | [tornadoweb/tornado](https://github.com/tornadoweb/tornado) |
| CoAP binding | :heavy_check_mark: | [chrysn/aiocoap](https://github.com/chrysn/aiocoap) |
| MQTT binding | :heavy_check_mark: | [Yakifo/amqtt](https://github.com/Yakifo/amqtt) |
## Installation
```
pip install vo-wot
```
### Development
To install in development mode with all the test dependencies:
```
pip install -U -e .[tests,docs]
```
Some WoTPy features (e.g. CoAP binding) are not available outside of Linux. If you have Docker available in your system, and want to easily run the tests in a Linux environment (whether you're on macOS or Windows) you can use the Docker-based test script:
```
$ WOTPY_TESTS_MQTT_BROKER_URL=mqtt://192.168.1.141 ./pytest-docker-all.sh
...
+ docker run --rm -it -v /var/folders/zd/02pk7r3954s_t03lktjmvbdc0000gn/T/wotpy-547bed6bacf34ddc95b41eceb46553dd:/app -e WOTPY_TESTS_MQTT_BROKER_URL=mqtt://192.168.1.141 python:3.9 /bin/bash -c 'cd /app && pip install -U .[tests] && pytest -v --disable-warnings'
...
Python 3.8 :: OK
Python 3.9 :: OK
Python 3.10 :: OK
Python 3.11 :: OK
```
`WOTPY_TESTS_MQTT_BROKER_URL` defines the url of the MQTT broker. It will listen to port `1883` by default. If your broker is set up in a different way, you can provide the port in the url as well.
`WOTPY_TESTS_ZENOH_ROUTER_URL` defines the url of the Zenoh router. An example router url value is `tcp/192.168.1.1:7447` assuming the router is bound on the interface with the IP `192.168.1.1` and listens to port `7447`. Check the Zenoh router's output (`zenohd` command) for more info.
You can also test only for a specific Python version with the `PYTHON_TAG` variable and the `pytest-docker.sh` script like this:
```
$ WOTPY_TESTS_MQTT_BROKER_URL=mqtt://192.168.1.141 PYTHON_TAG=3.8 ./pytest-docker.sh
```
### Development in VSCode with devcontainers
We have also provided a convenient `devcontainer` configuration to better recreate your local development environment. VSCode should detect it if you have the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed.
## Docs
The documentation is currently hosted [here](https://netmode.gitlab.io/vo-wot/).
Alternatively to build the documentation, move to the `docs` folder and run:
```
make html
```
Raw data
{
"_id": null,
"home_page": null,
"name": "vo-wot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Nikos Filinis <nfilinis@netmode.ntua.gr>, Dimitris Spatharakis <dspatharakis@netmode.ntua.gr>",
"keywords": "wot, iot, gateway, fog, w3c, vo, virtual object",
"author": null,
"author_email": "Andres Garcia Mangas <andres.garcia@fundacionctic.org>",
"download_url": "https://files.pythonhosted.org/packages/15/fc/027f7e4d6d5d487ef26a1130a653ade01b970e57ab603e6fd04b5e1a2a6e/vo_wot-0.18.12.tar.gz",
"platform": null,
"description": "# VO-WoT\n\nThis repository is based on the Web of Things Python implementation [WoTPy](https://github.com/agmangas/wot-py).\n\n[](https://pypi.org/project/vo-wot/)\n\n## Introduction\n\nThis repository is a fork of the original [WoTPy](https://github.com/agmangas/wot-py) repository.\n\nVO-WoT is an experimental implementation of a [W3C WoT Runtime](https://github.com/w3c/wot-architecture/blob/master/proposals/terminology.md#wot-runtime) and the [W3C WoT Scripting API](https://github.com/w3c/wot-architecture/blob/master/proposals/terminology.md#scripting-api) in Python.\n\nInspired by the exploratory implementations located in the [Eclipse thingweb GitHub page](https://github.com/eclipse-thingweb/).\n\n## Features\n- Supports Python 3 with versions >= 3.8\n- Fully-implemented `WoT` interface.\n- Asynchronous I/O programming model based on coroutines.\n- Multiple client and server [Protocol Binding](https://github.com/w3c/wot-architecture/blob/master/proposals/terminology.md#protocol-binding) implementations.\n\n### Feature support matrix\n\n| Feature | Python 3 | Implementation based on |\n| -----------------: | ------------------ | ----------------------------------------------------------------------- |\n| HTTP binding | :heavy_check_mark: | [tornadoweb/tornado](https://github.com/tornadoweb/tornado) |\n| WebSockets binding | :heavy_check_mark: | [tornadoweb/tornado](https://github.com/tornadoweb/tornado) |\n| CoAP binding | :heavy_check_mark: | [chrysn/aiocoap](https://github.com/chrysn/aiocoap) |\n| MQTT binding | :heavy_check_mark: | [Yakifo/amqtt](https://github.com/Yakifo/amqtt) |\n\n\n## Installation\n```\npip install vo-wot\n```\n\n### Development\n\nTo install in development mode with all the test dependencies:\n\n```\npip install -U -e .[tests,docs]\n```\n\nSome WoTPy features (e.g. CoAP binding) are not available outside of Linux. If you have Docker available in your system, and want to easily run the tests in a Linux environment (whether you're on macOS or Windows) you can use the Docker-based test script:\n\n```\n$ WOTPY_TESTS_MQTT_BROKER_URL=mqtt://192.168.1.141 ./pytest-docker-all.sh\n...\n+ docker run --rm -it -v /var/folders/zd/02pk7r3954s_t03lktjmvbdc0000gn/T/wotpy-547bed6bacf34ddc95b41eceb46553dd:/app -e WOTPY_TESTS_MQTT_BROKER_URL=mqtt://192.168.1.141 python:3.9 /bin/bash -c 'cd /app && pip install -U .[tests] && pytest -v --disable-warnings'\n...\nPython 3.8 :: OK\nPython 3.9 :: OK\nPython 3.10 :: OK\nPython 3.11 :: OK\n```\n`WOTPY_TESTS_MQTT_BROKER_URL` defines the url of the MQTT broker. It will listen to port `1883` by default. If your broker is set up in a different way, you can provide the port in the url as well.\n\n`WOTPY_TESTS_ZENOH_ROUTER_URL` defines the url of the Zenoh router. An example router url value is `tcp/192.168.1.1:7447` assuming the router is bound on the interface with the IP `192.168.1.1` and listens to port `7447`. Check the Zenoh router's output (`zenohd` command) for more info.\n\nYou can also test only for a specific Python version with the `PYTHON_TAG` variable and the `pytest-docker.sh` script like this:\n\n```\n$ WOTPY_TESTS_MQTT_BROKER_URL=mqtt://192.168.1.141 PYTHON_TAG=3.8 ./pytest-docker.sh\n```\n### Development in VSCode with devcontainers\nWe have also provided a convenient `devcontainer` configuration to better recreate your local development environment. VSCode should detect it if you have the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed.\n\n## Docs\nThe documentation is currently hosted [here](https://netmode.gitlab.io/vo-wot/).\n\nAlternatively to build the documentation, move to the `docs` folder and run:\n\n```\nmake html\n```\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 National Technical University of Athens Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Virtual Object python implementation using a W3C WoT Runtime and the WoT Scripting API",
"version": "0.18.12",
"project_urls": {
"Documentation": "https://netmode.gitlab.io/vo-wot/",
"Repository": "https://gitlab.eclipse.org/eclipse-research-labs/nephele-project/vo-wot.git"
},
"split_keywords": [
"wot",
" iot",
" gateway",
" fog",
" w3c",
" vo",
" virtual object"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61c9fe371212c55bea4de89b8a3e7fcd27186a9917a532dbf3d39c6eca61445d",
"md5": "dd2958e6b7671b89e59ac9eae6a5be4f",
"sha256": "8ddd8e8b387c178ea7e40e75ec69e9485fe1a2679f32c4db92cefdedd37a5afd"
},
"downloads": -1,
"filename": "vo_wot-0.18.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd2958e6b7671b89e59ac9eae6a5be4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 146610,
"upload_time": "2024-11-12T14:29:04",
"upload_time_iso_8601": "2024-11-12T14:29:04.316073Z",
"url": "https://files.pythonhosted.org/packages/61/c9/fe371212c55bea4de89b8a3e7fcd27186a9917a532dbf3d39c6eca61445d/vo_wot-0.18.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15fc027f7e4d6d5d487ef26a1130a653ade01b970e57ab603e6fd04b5e1a2a6e",
"md5": "17a1ea9fa1081e5475b70a7405049179",
"sha256": "572719f8ab07a8fa8bda6e36f11a9a42aa4089b7eaabee89947d94de7808d292"
},
"downloads": -1,
"filename": "vo_wot-0.18.12.tar.gz",
"has_sig": false,
"md5_digest": "17a1ea9fa1081e5475b70a7405049179",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 99756,
"upload_time": "2024-11-12T14:29:10",
"upload_time_iso_8601": "2024-11-12T14:29:10.653082Z",
"url": "https://files.pythonhosted.org/packages/15/fc/027f7e4d6d5d487ef26a1130a653ade01b970e57ab603e6fd04b5e1a2a6e/vo_wot-0.18.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 14:29:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vo-wot"
}
