code quality, typechecking, linting, formatting

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 92
+per-file-ignores =
+    __init__.py: E402

.github/workflows/flake8.yml

@@ -0,0 +1,27 @@
+name: flake8
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.3.1']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Poetry ${{ matrix.poetry-version }}
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - name: Install dependencies
+        run: |
+          poetry install
+      - name: Run tests
+        run: make flake8

.github/workflows/formatting.yml

@@ -0,0 +1,33 @@
+name: formatting
+
+on: [push, pull_request]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.3.1']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Poetry ${{ matrix.poetry-version }}
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - name: Install packages
+        run: |
+          poetry install
+          npm install
+      - name: Check black
+        run: make checkblack
+      - name: Check isort
+        run: make checkisort
+      - uses: actions/setup-node@v3
+      - name: Check prettier
+        run: make checkprettier

.github/workflows/mypy.yml

@@ -0,0 +1,27 @@
+name: mypy
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.3.1']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Poetry ${{ matrix.poetry-version }}
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - name: Install dependencies
+        run: |
+          poetry install
+      - name: Run tests
+        run: make mypy

.github/workflows/pylint.yml

@@ -0,0 +1,27 @@
+name: pylint
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.3.1']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Poetry ${{ matrix.poetry-version }}
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - name: Install dependencies
+        run: |
+          poetry install
+      - name: Run tests
+        run: make pylint

.github/workflows/pyright.yml

@@ -0,0 +1,28 @@
+name: pyright
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.3.1']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Poetry ${{ matrix.poetry-version }}
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'poetry'
+      - name: Install dependencies
+        run: |
+          poetry install
+          npm install
+      - name: Run tests
+        run: make pyright

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: release github version
 on:
   push:
     tags:
-      - "[0-9]+.[0-9]+"
+      - '[0-9]+.[0-9]+.[0-9]+'
 jobs:
   build:
     runs-on: ubuntu-latest

.gitignore

@@ -1 +1,3 @@
 __pycache__
+node_modules
+.mypy_cache

.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,40 @@
+all: format check
+
+format: prettier isort black
+
+check: pyright pylint flake8 checkisort checkblack checkprettier
+
+prettier:
+	poetry run ./node_modules/.bin/prettier --write config.json manifest.json static templates
+
+pyright:
+	poetry run ./node_modules/.bin/pyright
+
+black:
+	poetry run black .
+
+flake8:
+	poetry run flake8
+
+mypy:
+	poetry run mypy
+
+isort:
+	poetry run isort .
+
+pylint:
+	poetry run pylint *.py
+
+checkprettier:
+	poetry run ./node_modules/.bin/prettier --check config.json manifest.json static templates
+
+checkblack:
+	poetry run black --check .
+
+checkisort:
+	poetry run isort --check-only .
+
+test:
+	PYTHONUNBUFFERED=1 \
+	DEBUG=true \
+	poetry run pytest

README.md

@@ -5,7 +5,6 @@ This is an example extension to help you organise and build you own.
 Try to include an image
 <img src="https://i.imgur.com/9i4xcQB.png">
 
-
 <h2>If your extension has API endpoints, include useful ones here</h2>
 
 <code>curl -H "Content-type: application/json" -X POST https://YOUR-LNBITS/YOUR-EXTENSION/api/v1/EXAMPLE -d '{"amount":"100","memo":"example"}' -H "X-Api-Key: YOUR_WALLET-ADMIN/INVOICE-KEY"</code>

__init__.py

@@ -1,8 +1,8 @@
 import asyncio
+from typing import List
 
 from fastapi import APIRouter
 from fastapi.staticfiles import StaticFiles
-
 from lnbits.db import Database
 from lnbits.helpers import template_renderer
 from lnbits.tasks import catch_everything_and_restart
@@ -11,6 +11,8 @@
 
 example_ext: APIRouter = APIRouter(prefix="/example", tags=["example"])
 
+scheduled_tasks: List[asyncio.Task] = []
+
 example_static_files = [
     {
         "path": "/example/static",
@@ -29,6 +31,7 @@ def example_renderer():
 from .views_api import *  # noqa: F401,F403
 
 
-def tpos_start():
+def example_start():
     loop = asyncio.get_event_loop()
-    loop.create_task(catch_everything_and_restart(wait_for_paid_invoices))
+    task = loop.create_task(catch_everything_and_restart(wait_for_paid_invoices))
+    scheduled_tasks.append(task)

config.json

@@ -1,6 +1,6 @@
 {
   "name": "Build your own!",
   "short_description": "Extension building guide",
-	"tile": "/example/static/bitcoin-extension.png",
+  "tile": "/example/static/bitcoin-extension.png",
   "contributors": ["github_username"]
 }

crud.py

@@ -2,4 +2,4 @@
 
 # add your dependencies here
 
-# add your fnctions here
+# add your functions here

manifest.json

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

package.json

@@ -0,0 +1,7 @@
+{
+  "name": "example",
+  "dependencies": {
+    "prettier": "^2.8.7",
+    "pyright": "^1.1.303"
+  }
+}