| Name | ubo-gui JSON |
| Version |
0.11.12
JSON |
| download |
| home_page | None |
| Summary | GUI sdk for Ubo Pod |
| upload_time | 2024-06-25 18:15:32 |
| maintainer | None |
| docs_url | None |
| author | Sassan Haradji |
| requires_python | <4.0,>=3.11 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Ubo GUI
GUI sdk for [Ubo Pod](https://github.com/ubopod)
## 📋 Requirements
- [Ubo Pod](https://github.com/ubopod)
- [headless-kivy-pi](https://github.com/ubopod/headless-kivy-pi)
## 📦 Installation
You can install it using this handle: headless-kivy-pi@git+<https://github.com/ubopod/ubo-gui.git>
```sh
# pip:
pip install headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git
# poetry:
poetry add headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git
```
## 🛠 Usage
Checkout [Ubo App](https://github.com/ubopod/ubo-app) to see a sample implementation.
## 🤝 Contributing
You need to have [Poetry](https://python-poetry.org/) installed on your machine.
To install poetry in Raspbian you need to follow these instructions to install rust compiler, this is temporary until [this issue](https://github.com/python-poetry/poetry/issues/7645) is resolved:
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
sudo apt-get install pkg-config libssl-dev
curl -sSL https://install.python-poetry.org | python3 -
```
After having poetry, to install the required dependencies, run the following command:
```sh
poetry install --with dev
```
Also be aware of [this issue](https://github.com/python-poetry/poetry/issues/1917) and until it is resolved you can manually disable keyring by prefixing your poetry commands like this:
```sh
PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring poetry install
```
You can run linter over whole codebase by running this command:
```sh
poetry run poe lint
```
### ⚠️ Important Note
Make sure to run `poetry run poe download_font` to download Material Symbols font.
## 🔒 License
This project is released under the Apache-2.0 License. See the [LICENSE](./LICENSE)
file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "ubo-gui",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Sassan Haradji",
"author_email": "sassanh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d6/b5/86700ec7dfec1d880cd0046282a7368321e1ea377de885f2625d63f771f8/ubo_gui-0.11.12.tar.gz",
"platform": null,
"description": "# Ubo GUI\n\nGUI sdk for [Ubo Pod](https://github.com/ubopod)\n\n## \ud83d\udccb Requirements\n\n- [Ubo Pod](https://github.com/ubopod)\n- [headless-kivy-pi](https://github.com/ubopod/headless-kivy-pi)\n\n## \ud83d\udce6 Installation\n\nYou can install it using this handle: headless-kivy-pi@git+<https://github.com/ubopod/ubo-gui.git>\n\n```sh\n# pip:\npip install headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git\n# poetry:\npoetry add headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git\n```\n\n## \ud83d\udee0 Usage\n\nCheckout [Ubo App](https://github.com/ubopod/ubo-app) to see a sample implementation.\n\n## \ud83e\udd1d Contributing\n\nYou need to have [Poetry](https://python-poetry.org/) installed on your machine.\n\nTo install poetry in Raspbian you need to follow these instructions to install rust compiler, this is temporary until [this issue](https://github.com/python-poetry/poetry/issues/7645) is resolved:\n\n```sh\ncurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\nsudo apt-get install pkg-config libssl-dev\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n\nAfter having poetry, to install the required dependencies, run the following command:\n\n```sh\npoetry install --with dev\n```\n\nAlso be aware of [this issue](https://github.com/python-poetry/poetry/issues/1917) and until it is resolved you can manually disable keyring by prefixing your poetry commands like this:\n\n```sh\nPYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring poetry install\n```\n\nYou can run linter over whole codebase by running this command:\n\n```sh\npoetry run poe lint\n```\n\n### \u26a0\ufe0f Important Note\n\nMake sure to run `poetry run poe download_font` to download Material Symbols font.\n\n## \ud83d\udd12 License\n\nThis project is released under the Apache-2.0 License. See the [LICENSE](./LICENSE)\nfile for more details.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "GUI sdk for Ubo Pod",
"version": "0.11.12",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fda40efc917b4c9c91d18d80967cad4b5188edc5141b87128243457b757c6952",
"md5": "9c4ac26b5f319476ae08b38a0d3b7c3c",
"sha256": "ea1c32c45f6968a5e1fe24b9ebb2bf832fbd4e55c82e1a77b8ebcb6743b200e7"
},
"downloads": -1,
"filename": "ubo_gui-0.11.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c4ac26b5f319476ae08b38a0d3b7c3c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 8598227,
"upload_time": "2024-06-25T18:15:28",
"upload_time_iso_8601": "2024-06-25T18:15:28.931515Z",
"url": "https://files.pythonhosted.org/packages/fd/a4/0efc917b4c9c91d18d80967cad4b5188edc5141b87128243457b757c6952/ubo_gui-0.11.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d6b586700ec7dfec1d880cd0046282a7368321e1ea377de885f2625d63f771f8",
"md5": "6548964bfda183092feb947e8b9a4fe3",
"sha256": "a313d2257f5a0a970d3acc532a9dd984d9f7f705abde5c52a197cc0ab410e2ce"
},
"downloads": -1,
"filename": "ubo_gui-0.11.12.tar.gz",
"has_sig": false,
"md5_digest": "6548964bfda183092feb947e8b9a4fe3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 8579022,
"upload_time": "2024-06-25T18:15:32",
"upload_time_iso_8601": "2024-06-25T18:15:32.128866Z",
"url": "https://files.pythonhosted.org/packages/d6/b5/86700ec7dfec1d880cd0046282a7368321e1ea377de885f2625d63f771f8/ubo_gui-0.11.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 18:15:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ubo-gui"
}
