# Volux Controller <!-- omit in toc -->
[](https://pypi.org/project/voluxcontroller)
[](https://pypi.org/project/voluxcontroller)
[](https://pypi.org/project/voluxcontroller)
## Table of Contents <!-- omit in toc -->
- [Installation](#installation)
- [Usage](#usage)
- [`VoluxController` - Source](#voluxcontroller---source)
- [Examples](#examples)
- [To-do List](#to-do-list)
- [Links](#links)
## Installation
```bash
pip install voluxcontroller
```
## Usage
### `VoluxController` - Source
#### Examples
<!-- TODO: fix this link when it breaks after moving this demo to voluxcli demos in future -->
- [Basic demo](https://gitlab.com/volux/volux/-/blob/master/voluxcontroller/demo.py) (available in the [main Volux repository](https://gitlab.com/volux/volux/))
<!-- TODO: add more example/s -->
## To-do List
<!-- TODO: add todo list (the irony) -->
- [x] Get `VoluxController` class working
- [x] Add `on_presses` callback to `VoluxController` class
- [x] Add basic example to documentation
- [ ] Replace link to basic example with a new example in a code block
- [ ] Add basic documentation
- [ ] Add more examples to documentation
- [ ] Add more detailed documentation
## Links
<!-- TODO: add website link -->
- 📖 [Documentation](https://gitlab.com/volux/volux#volux)
- 🐍 [Latest Release](https://pypi.org/project/voluxcontroller)
- 🧰 [Source Code](https://gitlab.com/volux/volux)
- 🐞 [Issue Tracker](https://gitlab.com/volux/volux/-/issues)
- `🐦 Twitter` [@DrTexx](https://twitter.com/DrTexx)
- `📨 Email` [denver.opensource@tutanota.com](mailto:denver.opensource@tutanota.com)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/volux/volux/",
"name": "voluxcontroller",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "",
"author": "DrTexx",
"author_email": "denver.opensource@tutanota.com",
"download_url": "https://files.pythonhosted.org/packages/5e/77/1d6227e4d0412a2b25bdd3a8cd892dde19444e4aba89bb836b7b0e2ff54c/voluxcontroller-0.1.0a2.tar.gz",
"platform": null,
"description": "# Volux Controller <!-- omit in toc -->\n\n[](https://pypi.org/project/voluxcontroller)\n[](https://pypi.org/project/voluxcontroller)\n[](https://pypi.org/project/voluxcontroller)\n\n## Table of Contents <!-- omit in toc -->\n\n- [Installation](#installation)\n- [Usage](#usage)\n - [`VoluxController` - Source](#voluxcontroller---source)\n - [Examples](#examples)\n- [To-do List](#to-do-list)\n- [Links](#links)\n\n\n## Installation \n\n```bash\npip install voluxcontroller\n```\n\n## Usage\n\n### `VoluxController` - Source\n\n#### Examples\n\n<!-- TODO: fix this link when it breaks after moving this demo to voluxcli demos in future -->\n- [Basic demo](https://gitlab.com/volux/volux/-/blob/master/voluxcontroller/demo.py) (available in the [main Volux repository](https://gitlab.com/volux/volux/))\n\n<!-- TODO: add more example/s -->\n\n## To-do List\n\n<!-- TODO: add todo list (the irony) -->\n\n- [x] Get `VoluxController` class working\n- [x] Add `on_presses` callback to `VoluxController` class\n- [x] Add basic example to documentation\n- [ ] Replace link to basic example with a new example in a code block\n- [ ] Add basic documentation\n- [ ] Add more examples to documentation\n- [ ] Add more detailed documentation\n\n## Links\n\n<!-- TODO: add website link -->\n- \ud83d\udcd6 [Documentation](https://gitlab.com/volux/volux#volux)\n- \ud83d\udc0d [Latest Release](https://pypi.org/project/voluxcontroller)\n- \ud83e\uddf0 [Source Code](https://gitlab.com/volux/volux)\n- \ud83d\udc1e [Issue Tracker](https://gitlab.com/volux/volux/-/issues)\n- `\ud83d\udc26 Twitter` [@DrTexx](https://twitter.com/DrTexx)\n- `\ud83d\udce8 Email` [denver.opensource@tutanota.com](mailto:denver.opensource@tutanota.com)\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "Controller/gamepad interface for Volux",
"version": "0.1.0a2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ba13d0df08b974dd649f55e8795ccc105e1f23b579f211f01226711b0adf4de",
"md5": "2f281d296e0da4a287500b2b84f29b13",
"sha256": "48ddc61571ac145f39e984350aeaf1c745a8741a2f5902a3f89c1ddf397ce454"
},
"downloads": -1,
"filename": "voluxcontroller-0.1.0a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f281d296e0da4a287500b2b84f29b13",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 3457,
"upload_time": "2023-04-15T08:30:22",
"upload_time_iso_8601": "2023-04-15T08:30:22.553891Z",
"url": "https://files.pythonhosted.org/packages/6b/a1/3d0df08b974dd649f55e8795ccc105e1f23b579f211f01226711b0adf4de/voluxcontroller-0.1.0a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e771d6227e4d0412a2b25bdd3a8cd892dde19444e4aba89bb836b7b0e2ff54c",
"md5": "442d149d3df6f8c78337d389336f5e8d",
"sha256": "0d7054d2c6cf64df1f7e670170daab9ede07dbc90081781aa25807b5538aa513"
},
"downloads": -1,
"filename": "voluxcontroller-0.1.0a2.tar.gz",
"has_sig": false,
"md5_digest": "442d149d3df6f8c78337d389336f5e8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 3038,
"upload_time": "2023-04-15T08:30:24",
"upload_time_iso_8601": "2023-04-15T08:30:24.808836Z",
"url": "https://files.pythonhosted.org/packages/5e/77/1d6227e4d0412a2b25bdd3a8cd892dde19444e4aba89bb836b7b0e2ff54c/voluxcontroller-0.1.0a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-15 08:30:24",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "volux",
"gitlab_project": "volux",
"lcname": "voluxcontroller"
}
JSON