Merge pull request #6 from XKNX/dev-setup-and-publishing

Dev setup and publishing

Author: martinhoefling

.github/workflows/ci.yml

@@ -26,6 +26,10 @@ jobs:
         run: |
           ruff check .
           
+      - name: Type check with Mypy
+        run: |
+          mypy src/knx_telegram_store
+          
       - name: Run Tests with Pytest
         run: |
           export PYTHONPATH=src

.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/knx-telegram-store
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

pyproject.toml

@@ -8,29 +8,34 @@ version = "0.1.0"
 description = "A standalone, host-agnostic Python library for KNX telegram persistence."
 readme = "README.md"
 requires-python = ">=3.12"
-license = {text = "MIT"}
+license = "MIT"
 authors = [
     {name = "Martin Hoefling"}
 ]
 keywords = ["knx", "home-assistant", "persistence", "storage", "telegram"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3.12",
     "Topic :: Home Automation",
     "Framework :: AsyncIO",
 ]
 dependencies = []
 
 [project.urls]
-Homepage = "https://github.com/martinhoefling/knx-telegram-store"
-Bug-Tracker = "https://github.com/martinhoefling/knx-telegram-store/issues"
+Homepage = "https://github.com/XKNX/knx-telegram-store"
+Bug-Tracker = "https://github.com/XKNX/knx-telegram-store/issues"
+
+[tool.setuptools]
+include-package-data = true
 
 [tool.setuptools.packages.find]
 where = ["src"]
 include = ["knx_telegram_store*"]
 
+[tool.setuptools.package-data]
+knx_telegram_store = ["py.typed"]
+
 [project.optional-dependencies]
 sqlite = ["aiosqlite>=0.20", "sqlalchemy[asyncio]>=2.0"]
 postgres = ["asyncpg>=0.29", "sqlalchemy[asyncio]>=2.0"]
@@ -39,6 +44,7 @@ dev = [
     "pytest-asyncio>=0.23",
     "pytest-cov>=4.1",
     "ruff>=0.3",
+    "mypy>=1.9",
     "aiosqlite>=0.20"
 ]
 

src/knx_telegram_store/backends/base_sql.py

@@ -138,7 +138,7 @@ async def query(self, query: TelegramQuery) -> TelegramQueryResult:
         stmt = select(self.telegrams)
 
         # 1. Base Filters
-        filters = []
+        filters: list[Any] = []
         if query.sources:
             filters.append(self.telegrams.c.source.in_(query.sources))
         if query.destinations:
@@ -225,7 +225,7 @@ async def query(self, query: TelegramQuery) -> TelegramQueryResult:
             for row in rows
         ]
 
-        limit_reached = total_count > (query.offset + query.limit)
+        limit_reached = (total_count or 0) > (query.offset + query.limit)
 
         return TelegramQueryResult(
             telegrams=telegrams,
@@ -236,7 +236,7 @@ async def query(self, query: TelegramQuery) -> TelegramQueryResult:
     async def count(self) -> int:
         """Return the total number of stored telegrams."""
         async with self.engine.connect() as conn:
-            return await conn.scalar(select(func.count()).select_from(self.telegrams))
+            return await conn.scalar(select(func.count()).select_from(self.telegrams)) or 0
 
     async def clear(self) -> None:
         """Remove all stored telegrams."""