feat: code quality (#7)

* 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"

README.md

@@ -1,4 +1,5 @@
 # DJ Livestream - <small>[LNbits](https://github.com/lnbits/lnbits) extension</small>
+
 <small>For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)</small>
 
 ## Help DJ's and music producers conduct music livestreams

__init__.py

@@ -3,11 +3,11 @@
 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_livestream")
+from .crud import db
+from .tasks import wait_for_paid_invoices
+from .views import livestream_generic_router
+from .views_api import livestream_api_router
+from .views_lnurl import livestream_lnurl_router
 
 livestream_static_files = [
     {
@@ -17,27 +17,32 @@
 ]
 
 livestream_ext: APIRouter = APIRouter(prefix="/livestream", tags=["livestream"])
-
-
-def livestream_renderer():
-    return template_renderer(["livestream/templates"])
-
-
-from .lnurl import *  # noqa: F401,F403
-from .tasks import wait_for_paid_invoices
-from .views import *  # noqa: F401,F403
-from .views_api import *  # noqa: F401,F403
-
+livestream_ext.include_router(livestream_generic_router)
+livestream_ext.include_router(livestream_api_router)
+livestream_ext.include_router(livestream_lnurl_router)
 
 scheduled_tasks: list[asyncio.Task] = []
 
+
 def livestream_stop():
     for task in scheduled_tasks:
         try:
             task.cancel()
         except Exception as ex:
             logger.warning(ex)
 
+
 def livestream_start():
+    from lnbits.tasks import create_permanent_unique_task
+
     task = create_permanent_unique_task("ext_livestream", wait_for_paid_invoices)
     scheduled_tasks.append(task)
+
+
+__all__ = [
+    "livestream_ext",
+    "livestream_static_files",
+    "livestream_start",
+    "livestream_stop",
+    "db",
+]

config.json

@@ -2,10 +2,7 @@
   "name": "DJ Livestream",
   "short_description": "Sell tracks and split revenue (lnurl-pay)",
   "tile": "/livestream/static/image/livestream.png",
-  "contributors": [
-    "fiatjaf",
-    "cryptograffiti"
-  ],
+  "contributors": ["fiatjaf", "cryptograffiti"],
   "min_lnbits_version": "0.12.5",
   "hidden": false
 }

crud.py

@@ -1,17 +1,18 @@
-from typing import List, Optional
+from typing import Optional
 
 from lnbits.core.crud import create_account, create_wallet
-from lnbits.db import SQLITE
+from lnbits.db import SQLITE, Database
 
-from . import db
 from .models import Livestream, Producer, Track
 
+db = Database("ext_livestream")
+
 
 async def create_livestream(*, wallet_id: str) -> int:
     returning = "" if db.type == SQLITE else "RETURNING ID"
     method = db.execute if db.type == SQLITE else db.fetchone
 
-    result = await (method)(
+    result = await method(
         f"""
         INSERT INTO livestream.livestreams (wallet)
         VALUES (?)
@@ -85,7 +86,8 @@ async def add_track(
 ) -> int:
     result = await db.execute(
         """
-        INSERT INTO livestream.tracks (livestream, name, download_url, price_msat, producer)
+        INSERT INTO livestream.tracks \
+        (livestream, name, download_url, price_msat, producer)
         VALUES (?, ?, ?, ?, ?)
         """,
         (livestream, name, download_url, price_msat, producer),
@@ -129,7 +131,7 @@ async def get_track(track_id: Optional[int]) -> Optional[Track]:
     return Track(**row) if row else None
 
 
-async def get_tracks(livestream: int) -> List[Track]:
+async def get_tracks(livestream: int) -> list[Track]:
     rows = await db.fetchall(
         """
         SELECT id, download_url, price_msat, name, producer
@@ -193,7 +195,7 @@ async def get_producer(producer_id: int) -> Optional[Producer]:
     return Producer(**row) if row else None
 
 
-async def get_producers(livestream: int) -> List[Producer]:
+async def get_producers(livestream: int) -> list[Producer]:
     rows = await db.fetchall(
         """
         SELECT id, "user", wallet, name

manifest.json

@@ -1,9 +1,9 @@
 {
-    "repos": [
-        {
-            "id": "livestream",
-            "organisation": "lnbits",
-            "repository": "livestream"
-        }
-    ]
+  "repos": [
+    {
+      "id": "livestream",
+      "organisation": "lnbits",
+      "repository": "livestream"
+    }
+  ]
 }

migrations.py

@@ -2,6 +2,7 @@ async def m001_initial(db):
     """
     Initial livestream tables.
     """
+    ref = db.references_schema
     await db.execute(
         f"""
         CREATE TABLE livestream.livestreams (
@@ -16,7 +17,7 @@ async def m001_initial(db):
     await db.execute(
         f"""
         CREATE TABLE livestream.producers (
-            livestream INTEGER NOT NULL REFERENCES {db.references_schema}livestreams (id),
+            livestream INTEGER NOT NULL REFERENCES {ref}livestreams (id),
             id {db.serial_primary_key},
             "user" TEXT NOT NULL,
             wallet TEXT NOT NULL,
@@ -28,12 +29,12 @@ async def m001_initial(db):
     await db.execute(
         f"""
         CREATE TABLE livestream.tracks (
-            livestream INTEGER NOT NULL REFERENCES {db.references_schema}livestreams (id),
+            livestream INTEGER NOT NULL REFERENCES {ref}livestreams (id),
             id {db.serial_primary_key},
             download_url TEXT,
             price_msat INTEGER NOT NULL DEFAULT 0,
             name TEXT,
-            producer INTEGER REFERENCES {db.references_schema}producers (id) NOT NULL
+            producer INTEGER REFERENCES {ref}producers (id) NOT NULL
         );
         """
     )

models.py

@@ -5,7 +5,6 @@
 from fastapi import Query, Request
 from lnurl import Lnurl
 from lnurl import encode as lnurl_encode
-from lnurl.models import ClearnetUrl, Max144Str, UrlAction
 from lnurl.types import LnurlPayMetadata
 from pydantic import BaseModel
 
@@ -73,24 +72,13 @@ async def lnurlpay_metadata(self) -> LnurlPayMetadata:
         ) + " Like this track? Send some sats in appreciation."
 
         if self.download_url:
-            description += f" Send {round(self.price_msat/1000)} sats or more and you can download it."
+            description += (
+                f"Send {round(self.price_msat/1000)} "
+                "sats or more and you can download it."
+            )
 
         return LnurlPayMetadata(json.dumps([["text/plain", description]]))
 
-    def success_action(
-        self, payment_hash: str, request: Request
-    ) -> Optional[UrlAction]:
-        if not self.download_url:
-            return None
-
-        url = str(request.url_for("livestream.track_redirect_download", track_id=self.id))
-        url_with_query = f"{url}?p={payment_hash}"
-
-        return UrlAction(
-            url=ClearnetUrl(url_with_query, scheme="https"),
-            description=Max144Str(f"Download the track {self.name}!"),
-        )
-
 
 class Producer(BaseModel):
     id: int

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "livestream",
+  "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"
+  }
+}