Extension: add example extension (#644)

* add example ext files

* remove from extension list

lnbits/extensions/example/README.md

@@ -0,0 +1,11 @@
+<h1>Example Extension</h1>
+<h2>*tagline*</h2>
+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>

lnbits/extensions/example/__init__.py

@@ -0,0 +1,19 @@
+from fastapi import APIRouter
+
+from lnbits.db import Database
+from lnbits.helpers import template_renderer
+
+db = Database("ext_example")
+
+example_ext: APIRouter = APIRouter(
+    prefix="/example",
+    tags=["example"]
+)
+
+
+def example_renderer():
+    return template_renderer(["lnbits/extensions/example/templates"])
+
+
+from .views import *  # noqa
+from .views_api import *  # noqa

lnbits/extensions/example/example.config.json

@@ -0,0 +1,6 @@
+{
+  "name": "Build your own!!",
+  "short_description": "Join us, make an extension",
+  "icon": "info",
+  "contributors": ["github_username"]
+}

lnbits/extensions/example/migrations.py

@@ -0,0 +1,10 @@
+# async def m001_initial(db):
+#    await db.execute(
+#        f"""
+#        CREATE TABLE example.example (
+#            id TEXT PRIMARY KEY,
+#            wallet TEXT NOT NULL,
+#            time TIMESTAMP NOT NULL DEFAULT {db.timestamp_now}
+#        );
+#    """
+#    )

lnbits/extensions/example/models.py

@@ -0,0 +1,6 @@
+# from pydantic import BaseModel
+
+# class Example(BaseModel):
+#    id: str
+#    wallet: str
+

lnbits/extensions/example/templates/example/index.html

@@ -0,0 +1,59 @@
+{% extends "base.html" %} {% from "macros.jinja" import window_vars with context
+%} {% block page %}
+<q-card>
+  <q-card-section>
+    <h5 class="text-subtitle1 q-mt-none q-mb-md">
+      Frameworks used by {{SITE_TITLE}}
+    </h5>
+    <q-list>
+      <q-item
+        v-for="tool in tools"
+        :key="tool.name"
+        tag="a"
+        :href="tool.url"
+        target="_blank"
+      >
+        {% raw %}
+        <!-- with raw Flask won't try to interpret the Vue moustaches -->
+        <q-item-section>
+          <q-item-label>{{ tool.name }}</q-item-label>
+          <q-item-label caption>{{ tool.language }}</q-item-label>
+        </q-item-section>
+        {% endraw %}
+      </q-item>
+    </q-list>
+    <q-separator class="q-my-lg"></q-separator>
+    <p>
+      A magical "g" is always available, with info about the user, wallets and
+      extensions:
+    </p>
+    <code class="text-caption">{% raw %}{{ g }}{% endraw %}</code>
+  </q-card-section>
+</q-card>
+{% endblock %} {% block scripts %} {{ window_vars(user) }}
+<script>
+  new Vue({
+    el: '#vue',
+    mixins: [windowMixin],
+    data: function () {
+      return {
+        tools: []
+      }
+    },
+    created: function () {
+      var self = this
+
+      // axios is available for making requests
+      axios({
+        method: 'GET',
+        url: '/example/api/v1/tools',
+        headers: {
+          'X-example-header': 'not-used'
+        }
+      }).then(function (response) {
+        self.tools = response.data
+      })
+    }
+  })
+</script>
+{% endblock %}

lnbits/extensions/example/views.py

@@ -0,0 +1,18 @@
+from fastapi import FastAPI, Request
+from fastapi.params import Depends
+from fastapi.templating import Jinja2Templates
+from starlette.responses import HTMLResponse
+
+from lnbits.core.models import User
+from lnbits.decorators import check_user_exists
+
+from . import example_ext, example_renderer
+
+templates = Jinja2Templates(directory="templates")
+
+
+@example_ext.get("/", response_class=HTMLResponse)
+async def index(request: Request, user: User = Depends(check_user_exists)):
+    return example_renderer().TemplateResponse(
+        "example/index.html", {"request": request, "user": user.dict()}
+    )

lnbits/extensions/example/views_api.py

@@ -0,0 +1,34 @@
+# views_api.py is for you API endpoints that could be hit by another service
+
+# add your dependencies here
+
+# import httpx
+# (use httpx just like requests, except instead of response.ok there's only the
+#  response.is_error that is its inverse)
+
+from . import example_ext
+
+# add your endpoints here
+
+@example_ext.get("/api/v1/tools")
+async def api_example():
+    """Try to add descriptions for others."""
+    tools = [
+        {
+            "name": "fastAPI",
+            "url": "https://fastapi.tiangolo.com/",
+            "language": "Python",
+        },
+        {
+            "name": "Vue.js",
+            "url": "https://vuejs.org/",
+            "language": "JavaScript",
+        },
+        {
+            "name": "Quasar Framework",
+            "url": "https://quasar.dev/",
+            "language": "JavaScript",
+        },
+    ]
+
+    return tools