Add fist version of a TrailBase Python client including tests and CI setup

ignatz · ignatz · commit 07f0500f9fd6 · 2024-11-27T13:29:56.000+01:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -36,5 +36,10 @@ jobs:
         with:
           toolchain: stable
           default: true
-      - uses: actions/setup-python@v3
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Poetry install
+        run: |
+          pipx install poetry && poetry -C client/trailbase-py install
       - uses: pre-commit/action@v3.0.1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -79,7 +79,7 @@ repos:
 
     - id: build_website
       name: Build Website
-      entry: sh -c 'cd docs && pnpm i && pnpm build'
+      entry: sh -c 'cd docs && pnpm build'
       language: system
       types: [file]
       files: .*\.(js|mjs|cjs|ts|jsx|tsx|astro)$
@@ -126,3 +126,28 @@ repos:
       types: [file]
       files: .*\.(cs|csproj)$
       pass_filenames: false
+
+    ### Python client
+    - id: python_format
+      name: Python format
+      entry: poetry -C client/trailbase-py run black client/trailbase-py --check
+      language: system
+      types: [file]
+      files: .*\.(py)$
+      pass_filenames: false
+
+    - id: python_check
+      name: Python check
+      entry: poetry -C client/trailbase-py run pyright client/trailbase-py
+      language: system
+      types: [file]
+      files: .*\.(py)$
+      pass_filenames: false
+
+    - id: python_test
+      name: Python test
+      entry: poetry -C client/trailbase-py run pytest
+      language: system
+      types: [file]
+      files: .*\.(py)$
+      pass_filenames: false
diff --git a/Makefile b/Makefile
@@ -8,13 +8,15 @@ format:
 		cargo +nightly fmt; \
 		dart format client/trailbase-dart/ examples/blog/flutter/; \
 		txtpbfmt `find . -regex ".*.textproto"`; \
-		dotnet format client/trailbase-dotnet
+		dotnet format client/trailbase-dotnet; \
+		poetry -C client/trailbase-py run black client/trailbase-py
 
 check:
 	pnpm -r check; \
 		cargo clippy --workspace --no-deps; \
 		dart analyze client/trailbase-dart examples/blog/flutter; \
-		dotnet format client/trailbase-dotnet --verify-no-changes
+		dotnet format client/trailbase-dotnet --verify-no-changes; \
+		poetry -C client/trailbase-py run pyright
 
 docker:
 	docker build . -t trailbase/trailbase
diff --git a/README.md b/README.md
@@ -64,6 +64,7 @@ Moreover, client packages and containers are available via:
 - [JavaScript/Typescript client](https://www.npmjs.com/package/trailbase)
 - [Dart/Flutter client](https://pub.dev/packages/trailbase)
 - [C#/.Net](https://www.nuget.org/packages/TrailBase/)
+- [Python](https://github.com/trailbaseio/trailbase/tree/main/client/trailbase-py)
 
 ## Running
 
diff --git a/client/trailbase-dart/test/trailbase_test.dart b/client/trailbase-dart/test/trailbase_test.dart
@@ -149,6 +149,14 @@ Future<void> main() async {
       expect(RecordId.uuid(record.id) == ids[0], isTrue);
 
       expect(record.textNotNull, messages[0]);
+
+      final updatedMessage = 'dart client updated test 0: ${now}';
+      await api.update(ids[0], {'text_not_null': updatedMessage});
+      final updatedRecord = SimpleStrict.fromJson(await api.read(ids[0]));
+      expect(updatedRecord.textNotNull, updatedMessage);
+
+      await api.delete(ids[0]);
+      expect(() async => await api.read(ids[0]), throwsException);
     });
   });
 }
diff --git a/client/trailbase-dotnet/README.md b/client/trailbase-dotnet/README.md
@@ -1,4 +1,4 @@
-# TrailBase client library for .NET and MAUI
+# TrailBase Client Library for .NET and MAUI
 
 TrailBase is a [blazingly](https://trailbase.io/reference/benchmarks/) fast,
 single-file, open-source application server with type-safe APIs, built-in
diff --git a/client/trailbase-py/.gitignore b/client/trailbase-py/.gitignore
@@ -0,0 +1,2 @@
+**/__pycache__/
+poetry.lock
diff --git a/client/trailbase-py/README.md b/client/trailbase-py/README.md
@@ -0,0 +1,8 @@
+# TrailBase Client for Python
+
+TrailBase is a [blazingly](https://trailbase.io/reference/benchmarks/) fast,
+single-file, open-source application server with type-safe APIs, built-in
+JS/ES6/TS Runtime, Auth, and Admin UI built on Rust+SQLite+V8.
+
+For more context, documentation, and an online demo, check out our website
+[trailbase.io](https://trailbase.io).
diff --git a/client/trailbase-py/poetry.toml b/client/trailbase-py/poetry.toml
@@ -0,0 +1,3 @@
+[virtualenvs]
+in-project = true
+create = true
diff --git a/client/trailbase-py/pyproject.toml b/client/trailbase-py/pyproject.toml
@@ -0,0 +1,28 @@
+[tool.poetry]
+name = "trailbase"
+version = "0.1.0"
+description = ""
+authors = ["TrailBase <contact@trailbase.io>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+httpx = "^0.27.2"
+pyjwt = "^2.10.0"
+cryptography = "^43.0.3"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.3"
+black = "^24.10.0"
+pyright = "^1.1.389"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 108
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
diff --git a/client/trailbase-py/tests/__init__.py b/client/trailbase-py/tests/__init__.py
diff --git a/client/trailbase-py/tests/test_client.py b/client/trailbase-py/tests/test_client.py
@@ -0,0 +1,158 @@
+from re import sub
+from trailbase import Client, RecordId
+
+import httpx
+import logging
+import os
+import pytest
+import subprocess
+
+from time import time, sleep
+
+logging.basicConfig(level=logging.DEBUG)
+
+port = 4007
+address = f"127.0.0.1:{port}"
+site = f"http://{address}"
+
+
+class TrailBaseFixture:
+    process: None | subprocess.Popen
+
+    def __init__(self) -> None:
+        cwd = os.getcwd()
+        traildepot = "../testfixture" if cwd.endswith("trailbase-py") else "client/testfixture"
+
+        logger.info("Building TrailBase")
+        build = subprocess.run(["cargo", "build"])
+        assert build.returncode == 0
+
+        logger.info("Starting TrailBase")
+        self.process = subprocess.Popen(
+            [
+                "cargo",
+                "run",
+                "--",
+                "--data-dir",
+                traildepot,
+                "run",
+                "-a",
+                address,
+                "--js-runtime-threads",
+                "1",
+            ]
+        )
+
+        client = httpx.Client()
+        for _ in range(100):
+            try:
+                response = client.get(f"http://{address}/api/healthcheck")
+                if response.status_code == 200:
+                    return
+            except:
+                pass
+
+            sleep(0.5)
+
+        logger.error("Failed ot start TrailBase")
+
+    def isUp(self) -> bool:
+        p = self.process
+        return p != None and p.returncode == None
+
+    def shutdown(self) -> None:
+        p = self.process
+        if p != None:
+            p.send_signal(9)
+            p.wait()
+            assert isinstance(p.returncode, int)
+
+
+@pytest.fixture(scope="session")
+def trailbase():
+    fixture = TrailBaseFixture()
+    yield fixture
+    fixture.shutdown()
+
+
+def connect() -> Client:
+    client = Client(site, tokens=None)
+    client.login("admin@localhost", "secret")
+    return client
+
+
+def test_client_login(trailbase: TrailBaseFixture):
+    assert trailbase.isUp()
+
+    client = connect()
+    assert client.site() == site
+
+    tokens = client.tokens()
+    assert tokens != None and tokens.isValid()
+
+    user = client.user()
+    assert user != None and user.id != ""
+    assert user != None and user.email == "admin@localhost"
+
+    client.logout()
+    assert client.tokens() == None
+
+
+def test_records(trailbase: TrailBaseFixture):
+    assert trailbase.isUp()
+
+    client = connect()
+    api = client.records("simple_strict_table")
+
+    now = int(time())
+    messages = [
+        f"dart client test 0: {now}",
+        f"dart client test 1: {now}",
+    ]
+    ids: list[RecordId] = []
+    for msg in messages:
+        ids.append(api.create({"text_not_null": msg}))
+
+    if True:
+        records = api.list(
+            filters=[f"text_not_null={messages[0]}"],
+        )
+        assert len(records) == 1
+        assert records[0]["text_not_null"] == messages[0]
+
+    if True:
+        recordsAsc = api.list(
+            order=["+text_not_null"],
+            filters=[f"text_not_null[like]=%{now}"],
+        )
+
+        assert [el["text_not_null"] for el in recordsAsc] == messages
+
+        recordsDesc = api.list(
+            order=["-text_not_null"],
+            filters=[f"text_not_null[like]=%{now}"],
+        )
+
+        assert [el["text_not_null"] for el in recordsDesc] == list(reversed(messages))
+
+    if True:
+        record = api.read(ids[0])
+        assert record["text_not_null"] == messages[0]
+
+        record = api.read(ids[1])
+        assert record["text_not_null"] == messages[1]
+
+    if True:
+        updatedMessage = f"dart client updated test 0: {now}"
+        api.update(ids[0], {"text_not_null": updatedMessage})
+        record = api.read(ids[0])
+        assert record["text_not_null"] == updatedMessage
+
+    if True:
+        api.delete(ids[0])
+
+        with pytest.raises(Exception):
+            api.read(ids[0])
+
+
+logger = logging.getLogger(__name__)
diff --git a/client/trailbase-py/trailbase/__init__.py b/client/trailbase-py/trailbase/__init__.py
diff --git a/client/trailbase-ts/README.md b/client/trailbase-ts/README.md
diff --git a/docs/src/assets/python_logo.svg b/docs/src/assets/python_logo.svg
diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# TrailBase client library for .NET and MAUI`
	`1`	`+# TrailBase Client Library for .NET and MAUI`
`2`	`2`
`3`	`3`	`TrailBase is a [blazingly](https://trailbase.io/reference/benchmarks/) fast,`
`4`	`4`	`single-file, open-source application server with type-safe APIs, built-in`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[virtualenvs]`
	`2`	`+in-project = true`
	`3`	`+create = true`