Add initial information and test CI

Author: TomBursch

.github/workflows/pytest.yml

@@ -0,0 +1,32 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Pytesting
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+        cache: 'pip'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test]
+        pip install -e .[lint]
+    - name: Lint with Ruff
+      run: |
+        ruff check --output-format=github .
+    - name: Test with pytest and coverage
+      run: |
+        pytest --cov=./ --cov-report=term

pyproject.toml

@@ -1,15 +1,12 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
 [project]
 name = "kitchenowl-python"
 description = "A python wrapper for the KitchenOwl API"
 readme = "README.md"
 keywords = ["kitchenowl"]
-version = "0.1.0"
+version = "0.0.1"
 authors = [
-    {name = "super-qua"}
+    {name = "super-qua"},
+    {name = "Tom Bursch", email = "tom@kitchenowl.org"}
 ]
 license = {file = "LICENSE"}
 classifiers = [
@@ -33,7 +30,9 @@ lint = [
 ]
 
 [project.urls]
-Repository = "https://github.com/super-qua/kitchenowl-python"
+Homepage = "https://kitchenowl.org"
+Repository = "https://github.com/tombursch/kitchenowl-python"
+Issues = "https://github.com/TomBursch/kitchenowl/issues"
 
 
 [tool.pytest.ini_options]

src/kitchenowl_python/const.py

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

src/kitchenowl_python/exceptions.py

@@ -8,4 +8,4 @@ class KitchenOwlRequestException(KitchenOwlException):
     """Raised on a bad request to the KitchenOwl instance."""
 
 class KitchenOwlAuthException(KitchenOwlException):
-    """Raised when the authentication token is not valid."""
+    """Raised when the authentication token is not valid."""

tests/__init__.py

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

tests/data/__init__.py

@@ -0,0 +1 @@
+"""Constants for KitchenOwl tests."""

tests/data/defaults.py

@@ -259,4 +259,4 @@
     "ordering": 1,
     "support": 0,
     "updated_at": 0,
-}
+}

tests/test_kitchenowl.py

@@ -8,7 +8,6 @@
 from aiohttp.hdrs import METH_DELETE, METH_GET, METH_HEAD, METH_POST
 from aioresponses import CallbackResult, aioresponses
 
-import kitchenowl_python
 from kitchenowl_python.exceptions import KitchenOwlAuthException, KitchenOwlRequestException
 from kitchenowl_python.kitchenowl import KitchenOwl
 from kitchenowl_python.types import (