Prepare initial release

Author: TomBursch

.github/workflows/python-publish.yml

@@ -0,0 +1,65 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      url: https://pypi.org/p/kitchenowl-python
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.0.1
+
+- Initial release

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 super-qua
+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

README.md

@@ -3,11 +3,7 @@ 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.
-
-## Low Maintentance Project
-This project is a low maintenance project. The scope is purposefully kept narrow and I am not looking to extend this beyond its current scope.
-For this reason, issues and discussions are not activated for this project. Feel free to fork the project in case you feel like a functionality is missing.
+Currently, there is only support for managing shopping list items.
 
 ## Installation
 

pyproject.toml

@@ -5,12 +5,12 @@ readme = "README.md"
 keywords = ["kitchenowl"]
 version = "0.0.1"
 authors = [
+    {name = "Tom Bursch", email = "tom@kitchenowl.org"},
     {name = "super-qua"},
-    {name = "Tom Bursch", email = "tom@kitchenowl.org"}
 ]
 license = {file = "LICENSE"}
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 3 - Alpha",
   "Programming Language :: Python"
 ]
 dependencies = [
@@ -23,6 +23,7 @@ test = [
     "aioresponses == 0.7.6",
     "pytest == 8.2.2",
     "pytest-asyncio == 0.23.7",
+    "pytest-cov==6.0.0",
     "syrupy == 4.6.1"
 ]
 lint = [
@@ -33,6 +34,7 @@ lint = [
 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]

src/kitchenowl_python/exceptions.py

@@ -4,8 +4,10 @@
 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."""

src/kitchenowl_python/kitchenowl.py

@@ -115,9 +115,7 @@ async def _head(self, path: str) -> bool:
     async def _delete(self, path: str, json_data: dict) -> bool:
         """Perform a DELETE request to the KitchenOwl instance."""
 
-        return await self._request(
-            METH_DELETE, path=path, json_data=json_data, return_json=False
-        )
+        return await self._request(METH_DELETE, path=path, json_data=json_data, return_json=False)
 
     async def test_connection(self) -> bool:
         """Test the kitchenowl token by performing HEAD on the user endpoint.
@@ -184,9 +182,7 @@ async def get_shoppinglists(self, household_id) -> KitchenOwlShoppingListsRespon
             await self._get(f"api/household/{household_id}/shoppinglist")
         )
 
-    async def get_shoppinglist_items(
-        self, list_id: int
-    ) -> KitchenOwlShoppingListItemsResponse:
+    async def get_shoppinglist_items(self, list_id: int) -> KitchenOwlShoppingListItemsResponse:
         """Get all shopping list items on the list.
 
         Args:
@@ -301,9 +297,7 @@ async def update_shoppinglist_item_description(
         json_data = {"description": item_description}
 
         return KitchenOwlShoppingListItem(
-            await self._post(
-                f"api/shoppinglist/{list_id}/item/{item_id}", json_data, True
-            )
+            await self._post(f"api/shoppinglist/{list_id}/item/{item_id}", json_data, True)
         )
 
     async def remove_shoppinglist_item(self, list_id: int, item_id: int) -> bool:

tests/data/defaults.py

@@ -21,15 +21,15 @@
     "household_id": DEFAULT_HOUSEHOLD_ID,
     "id": DEFAULT_SHOPPINGLIST_ID_1,
     "name": f"list_{DEFAULT_SHOPPINGLIST_ID_1}",
-    "updated_at": 0
+    "updated_at": 0,
 }
 
 DEFAULT_SHOPPINGLIST_RESPONSE_2 = {
     "created_at": 0,
     "household_id": DEFAULT_HOUSEHOLD_ID,
     "id": DEFAULT_SHOPPINGLIST_ID_2,
     "name": f"list_{DEFAULT_SHOPPINGLIST_ID_2}",
-    "updated_at": 0
+    "updated_at": 0,
 }
 
 DEFAULT_USER_RESPONSE = {
@@ -41,7 +41,7 @@
     "owner": True,
     "photo": None,
     "updated_at": 0,
-    "username": f"user {DEFAULT_USER_ID}"
+    "username": f"user {DEFAULT_USER_ID}",
 }
 
 DEFAULT_HOUSEHOLDS_RESPONSE = [
@@ -56,12 +56,11 @@
         "photo": None,
         "planner_feature": True,
         "updated_at": 0,
-        "view_ordering": ["items","recipes"]
+        "view_ordering": ["items", "recipes"],
     }
 ]
 
 
-
 DEFAULT_SHOPPINGLIST_ITEM_RESPONSE = {
     "category": {
         "created_at": 0,

tests/test_kitchenowl.py

@@ -89,6 +89,7 @@ def default_shoppinglists_response(
     """Default items on the shopping list response."""
     return KitchenOwlShoppingListsResponse([default_shoppinglist, default_shoppinglist_2])
 
+
 @pytest.fixture
 def default_user_response() -> KitchenOwlUser:
     """Default items on the shopping list response."""
@@ -250,6 +251,7 @@ async def test_connection_test(responses: aioresponses, kitchenowl_api: KitchenO
     actual = await kitchenowl_api.test_connection()
     assert actual is True
 
+
 async def test_get_user_snapshot(
     default_user_response: KitchenOwlUser,
     responses: aioresponses,
@@ -275,6 +277,7 @@ async def test_get_user_snapshot(
         json=None,
     )
 
+
 async def test_get_households_snapshot(
     default_households_response: KitchenOwlHouseholdsResponse,
     responses: aioresponses,