| Name | frameutils JSON |
| Version |
0.1.15
JSON |
| download |
| home_page | None |
| Summary | Useful utilities for your Brilliant Frame AR glasses |
| upload_time | 2024-09-05 08:19:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | ISC License Copyright © 2023 Brilliant Labs Ltd. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Unless specified otherwise (see below), the above license and copyright applies to all files within this repository. Individual files or subdirectories may include additional copyright holders, or may be licensed under different terms. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Frame Utilities – for Python
Useful utilities for your Brilliant Frame such as a Bluetooth communication library, and font generation tools.
## Install
```sh
pip3 install frameutils
```
## Bluetooth communication library
As simple as:
```python
import asyncio
from frameutils import Bluetooth
async def main():
bluetooth = Bluetooth()
await bluetooth.connect()
print(await bluetooth.send_lua("print('hello world')", await_print=True))
print(await bluetooth.send_lua("print(1 + 2)", await_print=True))
await bluetooth.disconnect()
asyncio.run(main())
```
## Tests
To run the unit tests, ensure you have an unconnected Frame device in range, and then run:
```sh
python3 -m pytest tests/test_bluetooth.py
```
Raw data
{
"_id": null,
"home_page": null,
"name": "frameutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Brilliant Labs <info@brilliant.xyz>",
"download_url": "https://files.pythonhosted.org/packages/98/8b/a6a41af500098de087e4717640e519d514462ad08a5de8bccf7b240d59b4/frameutils-0.1.15.tar.gz",
"platform": null,
"description": "# Frame Utilities \u2013 for Python\n\nUseful utilities for your Brilliant Frame such as a Bluetooth communication library, and font generation tools.\n\n## Install\n\n```sh\npip3 install frameutils\n```\n\n## Bluetooth communication library\n\nAs simple as:\n\n```python\nimport asyncio\nfrom frameutils import Bluetooth\n\n\nasync def main():\n bluetooth = Bluetooth()\n await bluetooth.connect()\n\n print(await bluetooth.send_lua(\"print('hello world')\", await_print=True))\n print(await bluetooth.send_lua(\"print(1 + 2)\", await_print=True))\n\n await bluetooth.disconnect()\n\n\nasyncio.run(main())\n\n```\n\n## Tests\n\nTo run the unit tests, ensure you have an unconnected Frame device in range, and then run:\n\n```sh\npython3 -m pytest tests/test_bluetooth.py\n```",
"bugtrack_url": null,
"license": "ISC License Copyright \u00a9 2023 Brilliant Labs Ltd. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Unless specified otherwise (see below), the above license and copyright applies to all files within this repository. Individual files or subdirectories may include additional copyright holders, or may be licensed under different terms.",
"summary": "Useful utilities for your Brilliant Frame AR glasses",
"version": "0.1.15",
"project_urls": {
"Bug Tracker": "https://github.com/brilliantlabsAR/frame-utilities-for-python/issues",
"Homepage": "https://github.com/brilliantlabsAR/frame-utilities-for-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b6cb37ffa437fffefa119307f78a24e6c6ae03fd5960380e3bc3388e936eb6b",
"md5": "690c755102be5d36d1bcaeac8b8f8b78",
"sha256": "c0ce2b2095adbe81fb0e316eaec9584d3248e1e9b7759409d4207699a4b9e5c5"
},
"downloads": -1,
"filename": "frameutils-0.1.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "690c755102be5d36d1bcaeac8b8f8b78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7527,
"upload_time": "2024-09-05T08:19:08",
"upload_time_iso_8601": "2024-09-05T08:19:08.701862Z",
"url": "https://files.pythonhosted.org/packages/6b/6c/b37ffa437fffefa119307f78a24e6c6ae03fd5960380e3bc3388e936eb6b/frameutils-0.1.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "988ba6a41af500098de087e4717640e519d514462ad08a5de8bccf7b240d59b4",
"md5": "86c99f1d5e62428466dd85c44674fad9",
"sha256": "ae845275c6330d179e44ed4317ea7a738674d5c23fd32bcb63024a3d2d8f3095"
},
"downloads": -1,
"filename": "frameutils-0.1.15.tar.gz",
"has_sig": false,
"md5_digest": "86c99f1d5e62428466dd85c44674fad9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7191,
"upload_time": "2024-09-05T08:19:09",
"upload_time_iso_8601": "2024-09-05T08:19:09.854206Z",
"url": "https://files.pythonhosted.org/packages/98/8b/a6a41af500098de087e4717640e519d514462ad08a5de8bccf7b240d59b4/frameutils-0.1.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 08:19:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brilliantlabsAR",
"github_project": "frame-utilities-for-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "frameutils"
}
