kitchenowl-python 0.0.1__tar.gz

kitchenowl_python-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+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.

kitchenowl_python-0.0.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: kitchenowl-python
+Version: 0.0.1
+Summary: A python wrapper for the KitchenOwl API
+Author: super-qua
+Author-email: Tom Bursch <tom@kitchenowl.org>
+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.
+        
+Project-URL: Homepage, https://kitchenowl.org
+Project-URL: Repository, https://github.com/tombursch/kitchenowl-python
+Project-URL: Issues, https://github.com/TomBursch/kitchenowl/issues
+Project-URL: Changelog, https://github.com/tombursch/kitchenowl-python/blob/main/CHANGELOG.md
+Keywords: kitchenowl
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp==3.10.5
+Provides-Extra: test
+Requires-Dist: aioresponses==0.7.6; extra == "test"
+Requires-Dist: pytest==8.2.2; extra == "test"
+Requires-Dist: pytest-asyncio==0.23.7; extra == "test"
+Requires-Dist: pytest-cov==6.0.0; extra == "test"
+Requires-Dist: syrupy==4.6.1; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff==0.6.1; extra == "lint"
+
+# 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 .
+```
+
+

kitchenowl_python-0.0.1/README.md

@@ -0,0 +1,39 @@
+# 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 .
+```
+
+

kitchenowl_python-0.0.1/pyproject.toml

@@ -0,0 +1,195 @@
+[project]
+name = "kitchenowl-python"
+description = "A python wrapper for the KitchenOwl API"
+readme = "README.md"
+keywords = ["kitchenowl"]
+version = "0.0.1"
+authors = [
+    {name = "Tom Bursch", email = "tom@kitchenowl.org"},
+    {name = "super-qua"},
+]
+license = {file = "LICENSE"}
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Programming Language :: Python"
+]
+dependencies = [
+    "aiohttp == 3.10.5"
+]
+requires-python = ">=3.8"
+
+[project.optional-dependencies]
+test = [
+    "aioresponses == 0.7.6",
+    "pytest == 8.2.2",
+    "pytest-asyncio == 0.23.7",
+    "pytest-cov==6.0.0",
+    "syrupy == 4.6.1"
+]
+lint = [
+    "ruff == 0.6.1"
+]
+
+[project.urls]
+Homepage = "https://kitchenowl.org"
+Repository = "https://github.com/tombursch/kitchenowl-python"
+Issues = "https://github.com/TomBursch/kitchenowl/issues"
+Changelog = "https://github.com/tombursch/kitchenowl-python/blob/main/CHANGELOG.md"
+
+
+[tool.pytest.ini_options]
+minversion = 6.0
+pythonpath = "src"
+asyncio_mode = "auto"
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+]
+
+[tool.ruff]
+line-length = 100
+indent-width = 4
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
+
+[tool.ruff.lint]
+# linter rules copied from https://github.com/home-assistant/core/blob/dev/pyproject.toml
+select = [
+    "A001", # Variable {name} is shadowing a Python builtin
+    "ASYNC210", # Async functions should not call blocking HTTP methods
+    "ASYNC220", # Async functions should not create subprocesses with blocking methods
+    "ASYNC221", # Async functions should not run processes with blocking methods
+    "ASYNC222", # Async functions should not wait on processes with blocking methods
+    "ASYNC230", # Async functions should not open files with blocking methods like open
+    "ASYNC251", # Async functions should not call time.sleep
+    "B002", # Python does not support the unary prefix increment
+    "B005", # Using .strip() with multi-character strings is misleading
+    "B007", # Loop control variable {name} not used within loop body
+    "B014", # Exception handler with duplicate exception
+    "B015", # Pointless comparison. Did you mean to assign a value? Otherwise, prepend assert or remove it.
+    "B017", # pytest.raises(BaseException) should be considered evil
+    "B018", # Found useless attribute access. Either assign it to a variable or remove it.
+    "B023", # Function definition does not bind loop variable {name}
+    "B026", # Star-arg unpacking after a keyword argument is strongly discouraged
+    "B032", # Possible unintentional type annotation (using :). Did you mean to assign (using =)?
+    "B904", # Use raise from to specify exception cause
+    "B905", # zip() without an explicit strict= parameter
+    "BLE",
+    "C", # complexity
+    "COM818", # Trailing comma on bare tuple prohibited
+    "D", # docstrings
+    "DTZ003", # Use datetime.now(tz=) instead of datetime.utcnow()
+    "DTZ004", # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
+    "E", # pycodestyle
+    "F", # pyflakes/autoflake
+    "FLY", # flynt
+    "FURB", # refurb
+    "G", # flake8-logging-format
+    "I", # isort
+    "INP", # flake8-no-pep420
+    "ISC", # flake8-implicit-str-concat
+    "ICN001", # import concentions; {name} should be imported as {asname}
+    "LOG", # flake8-logging
+    "N804", # First argument of a class method should be named cls
+    "N805", # First argument of a method should be named self
+    "N815", # Variable {name} in class scope should not be mixedCase
+    "PERF", # Perflint
+    "PGH", # pygrep-hooks
+    "PIE", # flake8-pie
+    "PL", # pylint
+    "PT", # flake8-pytest-style
+    "PYI", # flake8-pyi
+    "RET", # flake8-return
+    "RSE", # flake8-raise
+    "RUF005", # Consider iterable unpacking instead of concatenation
+    "RUF006", # Store a reference to the return value of asyncio.create_task
+    "RUF010", # Use explicit conversion flag
+    "RUF013", # PEP 484 prohibits implicit Optional
+    "RUF017", # Avoid quadratic list summation
+    "RUF018", # Avoid assignment expressions in assert statements
+    "RUF019", # Unnecessary key check before dictionary access
+    # "RUF100", # Unused `noqa` directive; temporarily every now and then to clean them up
+    "S102", # Use of exec detected
+    "S103", # bad-file-permissions
+    "S108", # hardcoded-temp-file
+    "S306", # suspicious-mktemp-usage
+    "S307", # suspicious-eval-usage
+    "S313", # suspicious-xmlc-element-tree-usage
+    "S314", # suspicious-xml-element-tree-usage
+    "S315", # suspicious-xml-expat-reader-usage
+    "S316", # suspicious-xml-expat-builder-usage
+    "S317", # suspicious-xml-sax-usage
+    "S318", # suspicious-xml-mini-dom-usage
+    "S319", # suspicious-xml-pull-dom-usage
+    "S320", # suspicious-xmle-tree-usage
+    "S601", # paramiko-call
+    "S602", # subprocess-popen-with-shell-equals-true
+    "S604", # call-with-shell-equals-true
+    "S608", # hardcoded-sql-expression
+    "S609", # unix-command-wildcard-injection
+    "SIM", # flake8-simplify
+    "SLF", # flake8-self
+    "SLOT", # flake8-slots
+    "T100", # Trace found: {name} used
+    "T20", # flake8-print
+    "TID251", # Banned imports
+    "TRY", # tryceratops
+    "UP", # pyupgrade
+    "W", # pycodestyle
+]
+
+ignore = [
+    "D202", # No blank lines allowed after function docstring
+    "D203", # 1 blank line required before class docstring
+    "D213", # Multi-line docstring summary should start at the second line
+    "D406", # Section name should end with a newline
+    "D407", # Section name underlining
+    "E501", # line too long
+
+    "PLC1901", # {existing} can be simplified to {replacement} as an empty string is falsey; too many false positives
+    "PLR0911", # Too many return statements ({returns} > {max_returns})
+    "PLR0912", # Too many branches ({branches} > {max_branches})
+    "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
+    "PLR0915", # Too many statements ({statements} > {max_statements})
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
+    "PT004", # Fixture {fixture} does not return anything, add leading underscore
+    "PT011", # pytest.raises({exception}) is too broad, set the `match` parameter or use a more specific exception
+    "PT018", # Assertion should be broken down into multiple parts
+    "RUF001", # String contains ambiguous unicode character.
+    "RUF002", # Docstring contains ambiguous unicode character.
+    "RUF003", # Comment contains ambiguous unicode character.
+    "RUF015", # Prefer next(...) over single element slice
+    "SIM102", # Use a single if statement instead of nested if statements
+    "SIM103", # Return the condition {condition} directly
+    "SIM108", # Use ternary operator {contents} instead of if-else-block
+    "SIM115", # Use context handler for opening files
+    "TRY003", # Avoid specifying long messages outside the exception class
+    "TRY400", # Use `logging.exception` instead of `logging.error`
+    # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
+    "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
+
+    # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "W191",
+    "E111",
+    "E114",
+    "E117",
+    "D206",
+    "D300",
+    "Q",
+    "COM812",
+    "COM819",
+    "ISC001",
+
+    # Disabled because ruff does not understand type of __all__ generated by a function
+    "PLE0605",
+
+    # temporarily disabled
+    "RET503",
+    "TRY301"
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

kitchenowl_python-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kitchenowl_python-0.0.1/src/kitchenowl_python/__init__.py

@@ -0,0 +1,2 @@
+"""KitchenOwl API."""
+

kitchenowl_python-0.0.1/src/kitchenowl_python/const.py

@@ -0,0 +1 @@
+"""Constants for the KitchenOwl API."""

kitchenowl_python-0.0.1/src/kitchenowl_python/exceptions.py

@@ -0,0 +1,13 @@
+"""KitchenOwl exceptions."""
+
+
+class KitchenOwlException(Exception):
+    """Raised when a general exception occours."""
+
+
+class KitchenOwlRequestException(KitchenOwlException):
+    """Raised on a bad request to the KitchenOwl instance."""
+
+
+class KitchenOwlAuthException(KitchenOwlException):
+    """Raised when the authentication token is not valid."""