feat: code quality (#34)

* feat: code quality

.github/workflows/lint.yml

@@ -0,0 +1,10 @@
+name: lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    uses: lnbits/lnbits/.github/workflows/lint.yml@dev

.github/workflows/release.yml

@@ -1,10 +1,9 @@
 on:
   push:
     tags:
-      - "v[0-9]+.[0-9]+.[0-9]+"
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
-
   release:
     runs-on: ubuntu-latest
     steps:
@@ -34,12 +33,12 @@ jobs:
       - name: Create pull request in extensions repo
         env:
           GH_TOKEN: ${{ secrets.EXT_GITHUB }}
-          repo_name: "${{ github.event.repository.name }}"
-          tag: "${{ github.ref_name }}"
-          branch: "update-${{ github.event.repository.name }}-${{ github.ref_name }}"
-          title: "[UPDATE] ${{ github.event.repository.name }} to ${{ github.ref_name }}"
-          body: "https://github.com/lnbits/${{ github.event.repository.name }}/releases/${{ github.ref_name }}"
-          archive: "https://github.com/lnbits/${{ github.event.repository.name }}/archive/refs/tags/${{ github.ref_name }}.zip"
+          repo_name: '${{ github.event.repository.name }}'
+          tag: '${{ github.ref_name }}'
+          branch: 'update-${{ github.event.repository.name }}-${{ github.ref_name }}'
+          title: '[UPDATE] ${{ github.event.repository.name }} to ${{ github.ref_name }}'
+          body: 'https://github.com/lnbits/${{ github.event.repository.name }}/releases/${{ github.ref_name }}'
+          archive: 'https://github.com/lnbits/${{ github.event.repository.name }}/archive/refs/tags/${{ github.ref_name }}.zip'
         run: |
           cd lnbits-extensions
           git checkout -b $branch

.gitignore

@@ -1 +1,4 @@
 __pycache__
+node_modules
+.mypy_cache
+.venv

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": false,
+  "arrowParens": "avoid",
+  "insertPragma": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "singleQuote": true,
+  "trailingComma": "none",
+  "useTabs": false,
+  "bracketSameLine": false,
+  "bracketSpacing": false
+}

Makefile

@@ -0,0 +1,47 @@
+all: format check
+
+format: prettier black ruff
+
+check: mypy pyright checkblack checkruff checkprettier
+
+prettier:
+	poetry run ./node_modules/.bin/prettier --write .
+pyright:
+	poetry run ./node_modules/.bin/pyright
+
+mypy:
+	poetry run mypy .
+
+black:
+	poetry run black .
+
+ruff:
+	poetry run ruff check . --fix
+
+checkruff:
+	poetry run ruff check .
+
+checkprettier:
+	poetry run ./node_modules/.bin/prettier --check .
+
+checkblack:
+	poetry run black --check .
+
+checkeditorconfig:
+	editorconfig-checker
+
+test:
+	PYTHONUNBUFFERED=1 \
+	DEBUG=true \
+	poetry run pytest
+install-pre-commit-hook:
+	@echo "Installing pre-commit hook to git"
+	@echo "Uninstall the hook with poetry run pre-commit uninstall"
+	poetry run pre-commit install
+
+pre-commit:
+	poetry run pre-commit run --all-files
+
+
+checkbundle:
+	@echo "skipping checkbundle"

__init__.py

@@ -1,16 +1,16 @@
 import asyncio
-from loguru import logger
 
 from fastapi import APIRouter
+from loguru import logger
 
-from lnbits.db import Database
-from lnbits.helpers import template_renderer
-from lnbits.tasks import create_permanent_unique_task
-
-db = Database("ext_events")
-
+from .crud import db
+from .tasks import wait_for_paid_invoices
+from .views import events_generic_router
+from .views_api import events_api_router
 
 events_ext: APIRouter = APIRouter(prefix="/events", tags=["Events"])
+events_ext.include_router(events_generic_router)
+events_ext.include_router(events_api_router)
 
 events_static_files = [
     {
@@ -19,25 +19,22 @@
     }
 ]
 
-
-def events_renderer():
-    return template_renderer(["events/templates"])
-
-
-from .tasks import wait_for_paid_invoices
-from .views import *  # noqa: F401,F403
-from .views_api import *  # noqa: F401,F403
-
-
 scheduled_tasks: list[asyncio.Task] = []
 
+
 def events_stop():
     for task in scheduled_tasks:
         try:
             task.cancel()
         except Exception as ex:
             logger.warning(ex)
 
+
 def events_start():
+    from lnbits.tasks import create_permanent_unique_task
+
     task = create_permanent_unique_task("ext_events", wait_for_paid_invoices)
     scheduled_tasks.append(task)
+
+
+__all__ = ["db", "events_ext", "events_static_files", "events_start", "events_stop"]

crud.py

@@ -1,12 +1,12 @@
-from typing import List, Optional, Union
 from datetime import datetime, timedelta
+from typing import List, Optional, Union
 
+from lnbits.db import Database
 from lnbits.helpers import urlsafe_short_hash
 
-from . import db
 from .models import CreateEvent, Event, Ticket
 
-# TICKETS
+db = Database("ext_events")
 
 
 async def create_ticket(
@@ -90,7 +90,8 @@ async def purge_unpaid_tickets(event_id: str) -> None:
     time_diff = datetime.now() - timedelta(hours=24)
     await db.execute(
         f"""
-        DELETE FROM events.ticket WHERE event = ? AND paid = false AND time < {db.timestamp_placeholder}
+        DELETE FROM events.ticket WHERE event = ? AND paid = false
+        AND time < {db.timestamp_placeholder}
         """,
         (
             event_id,
@@ -99,14 +100,14 @@ async def purge_unpaid_tickets(event_id: str) -> None:
     )
 
 
-# EVENTS
-
-
 async def create_event(data: CreateEvent) -> Event:
     event_id = urlsafe_short_hash()
     await db.execute(
         """
-        INSERT INTO events.events (id, wallet, name, info, banner, closing_date, event_start_date, event_end_date, currency, amount_tickets, price_per_ticket, sold)
+        INSERT INTO events.events (
+            id, wallet, name, info, banner, closing_date, event_start_date,
+            event_end_date, currency, amount_tickets, price_per_ticket, sold
+        )
         VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
         """,
         (
@@ -174,7 +175,10 @@ async def get_event_tickets(event_id: str, wallet_id: str) -> List[Ticket]:
 
 async def reg_ticket(ticket_id: str) -> List[Ticket]:
     await db.execute(
-        f"UPDATE events.ticket SET registered = ?, reg_timestamp = {db.timestamp_now} WHERE id = ?",
+        f"""
+        UPDATE events.ticket SET registered = ?,
+        reg_timestamp = {db.timestamp_now} WHERE id = ?
+        """,
         (True, ticket_id),
     )
     ticket = await db.fetchone("SELECT * FROM events.ticket WHERE id = ?", (ticket_id,))

description.md

@@ -2,4 +2,4 @@ Sell tickets for events and use the built-in scanner for registering attendants
 
 Events alows you to make tickets for an event. Each ticket is in the form of a uniqque QR code. After registering, and paying for ticket, the user gets a QR code to present at registration/entrance.
 
-Events includes a shareable ticket scanner, which can be used to register attendees.
+Events includes a shareable ticket scanner, which can be used to register attendees.

models.py

@@ -1,6 +1,7 @@
+from typing import Optional
+
 from fastapi import Query
 from pydantic import BaseModel, EmailStr
-from typing import Optional
 
 
 class CreateEvent(BaseModel):

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "events",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "prettier": "^3.2.5",
+    "pyright": "^1.1.358"
+  }
+}