| Name | kitchenowl-python JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | A python wrapper for the KitchenOwl API |
| upload_time | 2025-02-09 15:40:18 |
| maintainer | None |
| docs_url | None |
| author | super-qua |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2024 super-qua, Tom Bursch
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 |
kitchenowl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# kitchenowl-python
A simple wrapper around the KitchenOwl API.
This is a small python package to be used as a wrapper for the KitchenOwl API in python.
Currently, there is only support for managing shopping list items.
## Installation
```shell
python -m venv .venv
source .venv/bin/activate
pip install -e .
```
Installs all required dependencies.
## Usage
```python
from aiohttp import ClientSession
from kitchenowl_python.kitchenowl import KitchenOwl
async with ClientSession() as session:
kitchenowl = KitchenOwl(session=session, url=url, token=token)
await kitchenowl.test_connection()
```
## Development
### Run tests
```shell
source .venv/bin/activate
pip install -e .\[test\]
pytest .
```
Raw data
{
"_id": null,
"home_page": null,
"name": "kitchenowl-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "kitchenowl",
"author": "super-qua",
"author_email": "Tom Bursch <tom@kitchenowl.org>",
"download_url": "https://files.pythonhosted.org/packages/03/92/72e9975af135076b6e4c4982eab9e8dc64618cb05c8520ff100bf2636815/kitchenowl_python-0.0.2.tar.gz",
"platform": null,
"description": "# kitchenowl-python \nA simple wrapper around the KitchenOwl API.\n\nThis is a small python package to be used as a wrapper for the KitchenOwl API in python.\n\nCurrently, there is only support for managing shopping list items.\n\n## Installation\n\n```shell\npython -m venv .venv\nsource .venv/bin/activate\npip install -e .\n```\nInstalls all required dependencies.\n\n## Usage\n\n```python\nfrom aiohttp import ClientSession\nfrom kitchenowl_python.kitchenowl import KitchenOwl\n\nasync with ClientSession() as session:\n kitchenowl = KitchenOwl(session=session, url=url, token=token)\n await kitchenowl.test_connection()\n\n```\n\n## Development\n\n### Run tests\n\n```shell\nsource .venv/bin/activate\npip install -e .\\[test\\]\npytest .\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 super-qua, Tom Bursch\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A python wrapper for the KitchenOwl API",
"version": "0.0.2",
"project_urls": {
"Changelog": "https://github.com/tombursch/kitchenowl-python/blob/main/CHANGELOG.md",
"Homepage": "https://kitchenowl.org",
"Issues": "https://github.com/TomBursch/kitchenowl/issues",
"Repository": "https://github.com/tombursch/kitchenowl-python"
},
"split_keywords": [
"kitchenowl"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cfc9878e2bcd1989e3b52e4281329bb3a1ed8b7eb370ab676077b2661571acf6",
"md5": "0b7b40869ed3e85b2932bccdb60c7ad0",
"sha256": "6b1b2498104372e8a43cce745b3a3ca0519181cca175b3d92cb15260dfa924c7"
},
"downloads": -1,
"filename": "kitchenowl_python-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b7b40869ed3e85b2932bccdb60c7ad0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7129,
"upload_time": "2025-02-09T15:40:16",
"upload_time_iso_8601": "2025-02-09T15:40:16.930640Z",
"url": "https://files.pythonhosted.org/packages/cf/c9/878e2bcd1989e3b52e4281329bb3a1ed8b7eb370ab676077b2661571acf6/kitchenowl_python-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "039272e9975af135076b6e4c4982eab9e8dc64618cb05c8520ff100bf2636815",
"md5": "0006af5a50b9e5242fcbff03607c0b24",
"sha256": "1cbce6a466add41c199fd963f52bbc58aa15fd18d889a27a22593a58c95e9980"
},
"downloads": -1,
"filename": "kitchenowl_python-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "0006af5a50b9e5242fcbff03607c0b24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11827,
"upload_time": "2025-02-09T15:40:18",
"upload_time_iso_8601": "2025-02-09T15:40:18.130517Z",
"url": "https://files.pythonhosted.org/packages/03/92/72e9975af135076b6e4c4982eab9e8dc64618cb05c8520ff100bf2636815/kitchenowl_python-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-09 15:40:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tombursch",
"github_project": "kitchenowl-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kitchenowl-python"
}
