# Pellet Dispenser Python Driver
This is a python package to use the pellet dispenser with python.
## Installing
Install this package with the following shell command
```bash
pip install unil-pellet-dispenser
```
`unil-pellet-dispenser` is based on [hid](https://pypi.org/project/hid/) and
therefore require the [hidapi library](https://github.com/libusb/hidapi) to be
installed separately.
### Installing hidapi
#### Linux
Depending on your distribution you will need to install a hidapi package.
##### Ubuntu / Debian based
```bash
sudo apt install libhidapi-hidraw0
```
#### macOS
The easiest is to use [Homebrew](https://brew.sh):
```bash
brew install hidapi
```
## Sample usage code
```python
from unil_pellet_dispenser import Device, DispenserError
dev = Device()
try:
dispensed = dev.dispense(1)
print(f'Dispensed {dispensed} pellets')
except DispenserError as e:
print(e)
print(f'still dispensed {e.dispensed}')
```
Raw data
{
"_id": null,
"home_page": null,
"name": "unil-pellet-dispenser",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pellet, dispenser, hardware, hid, Open Source Hardware",
"author": null,
"author_email": "Alexandre Tuleu <alexandre.tuleu.2005@polytechnique.org>",
"download_url": "https://files.pythonhosted.org/packages/91/41/1df023d1e7085e4558d729f63efe82aed34a1e43802f48164320f143f7ed/unil_pellet_dispenser-0.0.1.tar.gz",
"platform": null,
"description": "# Pellet Dispenser Python Driver\n\nThis is a python package to use the pellet dispenser with python.\n\n\n## Installing\n\nInstall this package with the following shell command\n\n```bash\npip install unil-pellet-dispenser\n```\n\n`unil-pellet-dispenser` is based on [hid](https://pypi.org/project/hid/) and\ntherefore require the [hidapi library](https://github.com/libusb/hidapi) to be\ninstalled separately.\n\n### Installing hidapi\n\n#### Linux\n\nDepending on your distribution you will need to install a hidapi package.\n\n##### Ubuntu / Debian based\n\n```bash\nsudo apt install libhidapi-hidraw0\n```\n\n\n#### macOS\n\nThe easiest is to use [Homebrew](https://brew.sh):\n\n```bash\nbrew install hidapi\n```\n\n\n## Sample usage code\n\n```python\n\nfrom unil_pellet_dispenser import Device, DispenserError\n\ndev = Device()\n\ntry:\n dispensed = dev.dispense(1)\n print(f'Dispensed {dispensed} pellets')\nexcept DispenserError as e:\n print(e)\n print(f'still dispensed {e.dispensed}')\n```\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "A Python package to contol University of Lausanne's pellet dispenser via USB",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/atuleu/zaci/tree/main/devices/pellet-dispenser/driver",
"Issues": "https://github.com/atuleu/zaci/issues?q=is%3Aissue+is%3Aopen+label%3A\"pellet dispenser\"",
"Repository": "https://github.com/atuleu/zaci"
},
"split_keywords": [
"pellet",
" dispenser",
" hardware",
" hid",
" open source hardware"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e37bbcfb36f28a610eebdafd991aec141626996343213ff5590d219ffe1dda8",
"md5": "0bac3a530c94aaf64d572ba133105584",
"sha256": "e964748d3c91aa5201c494da02615c0bdcb224e42efa9474ceee8b0cb6a90fe9"
},
"downloads": -1,
"filename": "unil_pellet_dispenser-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bac3a530c94aaf64d572ba133105584",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3788,
"upload_time": "2024-06-12T10:14:33",
"upload_time_iso_8601": "2024-06-12T10:14:33.981128Z",
"url": "https://files.pythonhosted.org/packages/7e/37/bbcfb36f28a610eebdafd991aec141626996343213ff5590d219ffe1dda8/unil_pellet_dispenser-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91411df023d1e7085e4558d729f63efe82aed34a1e43802f48164320f143f7ed",
"md5": "1546c28c8bf8167a1b0b963d789aa410",
"sha256": "3c68a347ad7e22f2bce82494a1aff4daadbbb565056b33aeed4a5a9f1e9b1c5f"
},
"downloads": -1,
"filename": "unil_pellet_dispenser-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1546c28c8bf8167a1b0b963d789aa410",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3491,
"upload_time": "2024-06-12T10:14:37",
"upload_time_iso_8601": "2024-06-12T10:14:37.020168Z",
"url": "https://files.pythonhosted.org/packages/91/41/1df023d1e7085e4558d729f63efe82aed34a1e43802f48164320f143f7ed/unil_pellet_dispenser-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 10:14:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "atuleu",
"github_project": "zaci",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "unil-pellet-dispenser"
}
JSON
