backlex 0.0.1__tar.gz

backlex-0.0.1/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+_generated/

backlex-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Furkan Kınyas
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

backlex-0.0.1/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: backlex
+Version: 0.0.1
+Summary: Official Python client for the backlex API (CRUD, query builder, auth, realtime, storage).
+Project-URL: Homepage, https://backlex.com
+Project-URL: Documentation, https://backlex.com/docs/client-sdks
+Project-URL: Repository, https://github.com/backlex/backlex
+Author: backlex
+License: Apache-2.0
+License-File: LICENSE
+Keywords: baas,backend,backlex,rest,sdk
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Requires-Dist: typing-extensions>=4.6; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# backlex — Python SDK
+
+Official Python client for the backlex API. A thin, typed wrapper over the same
+REST + SSE surface the TypeScript SDK (`@backlex/client`) speaks — CRUD, a fluent
+query builder, auth, realtime, and storage.
+
+This package is the **reference port** for backlex's multi-language SDK effort
+(Python → Go → .NET/Java → Swift/Kotlin). It demonstrates the **hybrid** model:
+hand-written ergonomic layer on top, optional OpenAPI-generated models
+underneath (see [Hybrid codegen](#hybrid-codegen)).
+
+```bash
+pip install backlex   # not yet published — for now: pip install -e sdks/python
+```
+
+## Quickstart
+
+```python
+from backlex import create_client
+
+client = create_client("https://api.example.com", api_key="pak_...")
+
+# CRUD
+post = client.from_("posts").create({"title": "Hello"})["data"]
+client.from_("posts").update(post["id"], {"title": "Edited"})
+client.from_("posts").delete(post["id"])
+
+# Fluent query builder → compiles to canonical JSON (same wire format as TS)
+rows = (
+    client.from_("orders").query()
+    .where(lambda f: f.and_(
+        f.eq("status", "active"),
+        f.gte("total", 100),
+        f.rel("customer", lambda c: c.eq("tier", "gold")),   # → "customer.tier"
+        f.gte("placed_at", f.now(sub={"months": 1})),
+    ))
+    .select("id", "total", "customer.name")
+    .order_by("-placed_at", "id")
+    .limit(50)
+    .list()
+)["data"]
+```
+
+## Auth
+
+```python
+# Server-to-server: pass api_key="pak_..." to create_client (bearer on every call).
+
+# App mode — end-users of a workspace:
+client = create_client("https://api.example.com", workspace="myapp")
+res = client.auth.sign_in("user@example.com", "password")   # token auto-captured
+token = client.auth.get_token()                              # persist this
+# later: create_client(..., workspace="myapp", token=token) to restore the session
+client.auth.sign_out()
+```
+
+`auth.providers()` returns the public auth surface (provider list + policy flags)
+for rendering a sign-in screen. `auth.sign_in_social(provider)` and
+`auth.sign_in_magic_link(email)` are also available.
+
+## Realtime (SSE)
+
+```python
+unsub = client.subscribe("items:posts", lambda ev: print(ev["event"], ev["data"]))
+# ... runs on a background daemon thread, auto-reconnects ...
+unsub()
+```
+
+## Storage
+
+```python
+client.storage.put("avatars/me.png", open("me.png", "rb").read(), "image/png")
+data = client.storage.download("avatars/me.png").content
+client.storage.list(prefix="avatars/")
+client.storage.delete("avatars/me.png")
+```
+
+## Errors
+
+Every non-2xx response raises `BacklexError` with `.status`, `.code`, and
+`.details` (the `{ "error": {...} }` envelope), so you branch on codes, not
+strings.
+
+## Hybrid codegen
+
+The hand-written layer above is stable and small. For **typed models** of your
+collections and the system API, generate them from the OpenAPI spec the server
+already ships — no Python-specific wire format is introduced.
+
+```bash
+# 1. System API models from the static OpenAPI spec:
+openapi-generator generate \
+  -i apps/web/src/server/lib/openapi-static.generated.json \
+  -g python -o sdks/python/_generated --skip-validate
+
+# 2. Per-collection types: the `backlex gen-types` CLI emits these for the
+#    TS SDK today; the Python equivalent reads /api/collections and writes
+#    TypedDicts you pass as `client.from_("posts")  # -> dict[Post]`.
+```
+
+Generated models live alongside (not inside) the hand-written package, so the
+ergonomic surface stays clean while models track the spec.
+
+## Develop
+
+```bash
+cd sdks/python
+pip install -e ".[dev]"
+pytest          # offline: query-builder + normalization contract tests
+mypy            # strict
+ruff check .
+```
+
+## Parity with the TS SDK
+
+| TS (`@backlex/client`)        | Python (`backlex`)                       |
+| ----------------------------- | ---------------------------------------- |
+| `createClient(opts)`          | `create_client(url, ...)`                |
+| `client.from(slug)`           | `client.from_(slug)`                     |
+| `.query().where(f => ...)`    | `.query().where(lambda f: ...)`          |
+| `f.and / or / not / in`       | `f.and_ / or_ / not_ / in_`              |
+| `.orderBy().withMeta()`       | `.order_by().with_meta()`                |
+| `client.subscribe(ch, cb)`    | `client.subscribe(ch, cb)` → `unsub()`   |
+| `auth.signIn / getToken`      | `auth.sign_in / get_token`               |
+| `BacklexError`                | `BacklexError`                           |

backlex-0.0.1/README.md

@@ -0,0 +1,125 @@
+# backlex — Python SDK
+
+Official Python client for the backlex API. A thin, typed wrapper over the same
+REST + SSE surface the TypeScript SDK (`@backlex/client`) speaks — CRUD, a fluent
+query builder, auth, realtime, and storage.
+
+This package is the **reference port** for backlex's multi-language SDK effort
+(Python → Go → .NET/Java → Swift/Kotlin). It demonstrates the **hybrid** model:
+hand-written ergonomic layer on top, optional OpenAPI-generated models
+underneath (see [Hybrid codegen](#hybrid-codegen)).
+
+```bash
+pip install backlex   # not yet published — for now: pip install -e sdks/python
+```
+
+## Quickstart
+
+```python
+from backlex import create_client
+
+client = create_client("https://api.example.com", api_key="pak_...")
+
+# CRUD
+post = client.from_("posts").create({"title": "Hello"})["data"]
+client.from_("posts").update(post["id"], {"title": "Edited"})
+client.from_("posts").delete(post["id"])
+
+# Fluent query builder → compiles to canonical JSON (same wire format as TS)
+rows = (
+    client.from_("orders").query()
+    .where(lambda f: f.and_(
+        f.eq("status", "active"),
+        f.gte("total", 100),
+        f.rel("customer", lambda c: c.eq("tier", "gold")),   # → "customer.tier"
+        f.gte("placed_at", f.now(sub={"months": 1})),
+    ))
+    .select("id", "total", "customer.name")
+    .order_by("-placed_at", "id")
+    .limit(50)
+    .list()
+)["data"]
+```
+
+## Auth
+
+```python
+# Server-to-server: pass api_key="pak_..." to create_client (bearer on every call).
+
+# App mode — end-users of a workspace:
+client = create_client("https://api.example.com", workspace="myapp")
+res = client.auth.sign_in("user@example.com", "password")   # token auto-captured
+token = client.auth.get_token()                              # persist this
+# later: create_client(..., workspace="myapp", token=token) to restore the session
+client.auth.sign_out()
+```
+
+`auth.providers()` returns the public auth surface (provider list + policy flags)
+for rendering a sign-in screen. `auth.sign_in_social(provider)` and
+`auth.sign_in_magic_link(email)` are also available.
+
+## Realtime (SSE)
+
+```python
+unsub = client.subscribe("items:posts", lambda ev: print(ev["event"], ev["data"]))
+# ... runs on a background daemon thread, auto-reconnects ...
+unsub()
+```
+
+## Storage
+
+```python
+client.storage.put("avatars/me.png", open("me.png", "rb").read(), "image/png")
+data = client.storage.download("avatars/me.png").content
+client.storage.list(prefix="avatars/")
+client.storage.delete("avatars/me.png")
+```
+
+## Errors
+
+Every non-2xx response raises `BacklexError` with `.status`, `.code`, and
+`.details` (the `{ "error": {...} }` envelope), so you branch on codes, not
+strings.
+
+## Hybrid codegen
+
+The hand-written layer above is stable and small. For **typed models** of your
+collections and the system API, generate them from the OpenAPI spec the server
+already ships — no Python-specific wire format is introduced.
+
+```bash
+# 1. System API models from the static OpenAPI spec:
+openapi-generator generate \
+  -i apps/web/src/server/lib/openapi-static.generated.json \
+  -g python -o sdks/python/_generated --skip-validate
+
+# 2. Per-collection types: the `backlex gen-types` CLI emits these for the
+#    TS SDK today; the Python equivalent reads /api/collections and writes
+#    TypedDicts you pass as `client.from_("posts")  # -> dict[Post]`.
+```
+
+Generated models live alongside (not inside) the hand-written package, so the
+ergonomic surface stays clean while models track the spec.
+
+## Develop
+
+```bash
+cd sdks/python
+pip install -e ".[dev]"
+pytest          # offline: query-builder + normalization contract tests
+mypy            # strict
+ruff check .
+```
+
+## Parity with the TS SDK
+
+| TS (`@backlex/client`)        | Python (`backlex`)                       |
+| ----------------------------- | ---------------------------------------- |
+| `createClient(opts)`          | `create_client(url, ...)`                |
+| `client.from(slug)`           | `client.from_(slug)`                     |
+| `.query().where(f => ...)`    | `.query().where(lambda f: ...)`          |
+| `f.and / or / not / in`       | `f.and_ / or_ / not_ / in_`              |
+| `.orderBy().withMeta()`       | `.order_by().with_meta()`                |
+| `client.subscribe(ch, cb)`    | `client.subscribe(ch, cb)` → `unsub()`   |
+| `auth.signIn / getToken`      | `auth.sign_in / get_token`               |
+| `BacklexError`                | `BacklexError`                           |

backlex-0.0.1/examples/quickstart.py

@@ -0,0 +1,60 @@
+"""End-to-end tour of the Python SDK.
+
+Run against a local dev server:
+
+    BACKLEX_URL=http://localhost:5173 BACKLEX_KEY=pak_... python examples/quickstart.py
+"""
+
+from __future__ import annotations
+
+import os
+
+from backlex import BacklexError, create_client
+
+
+def main() -> None:
+    url = os.environ.get("BACKLEX_URL", "http://localhost:5173")
+    key = os.environ.get("BACKLEX_KEY")  # pak_... server key
+
+    client = create_client(url, api_key=key)
+
+    # --- Query builder: compiles to canonical JSON, same wire format as TS ---
+    q = (
+        client.from_("posts")
+        .query()
+        .where(
+            lambda f: f.and_(
+                f.eq("published", True),
+                f.gte("views", 100),
+                f.rel("author", lambda a: a.eq("tier", "gold")),
+                f.gte("created_at", f.now(sub={"days": 7})),
+            )
+        )
+        .select("id", "title", "author.name")
+        .order_by("-created_at")
+        .limit(10)
+        .with_meta("filter_count")
+    )
+    print("compiled query:", q.to_query())
+
+    try:
+        res = q.list()
+        print(f"got {len(res['data'])} posts (filter_count={res.get('meta', {})})")
+    except BacklexError as e:
+        print(f"list failed: {e.status} {e.code} — {e}")
+
+    # --- CRUD ---------------------------------------------------------------
+    # created = client.from_("posts").create({"title": "Hello from Python"})
+    # client.from_("posts").update(created["data"]["id"], {"title": "Edited"})
+    # client.from_("posts").delete(created["data"]["id"])
+
+    # --- Realtime (SSE on a background thread) ------------------------------
+    # unsub = client.subscribe("items:posts", lambda ev: print("event:", ev["event"]))
+    # ... do work ...
+    # unsub()
+
+    client.close()
+
+
+if __name__ == "__main__":
+    main()

backlex-0.0.1/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "backlex"
+version = "0.0.1"
+description = "Official Python client for the backlex API (CRUD, query builder, auth, realtime, storage)."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+authors = [{ name = "backlex" }]
+keywords = ["backlex", "backend", "baas", "rest", "sdk"]
+dependencies = [
+  # Single runtime dependency: a modern HTTP client with streaming support
+  # (used for both request/response and the SSE realtime transport).
+  "httpx>=0.27",
+  # NotRequired / TypedDict back-port for Python < 3.11.
+  "typing_extensions>=4.6; python_version < '3.11'",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "mypy>=1.10", "ruff>=0.5"]
+
+[project.urls]
+Homepage = "https://backlex.com"
+Documentation = "https://backlex.com/docs/client-sdks"
+Repository = "https://github.com/backlex/backlex"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/backlex"]
+
+[tool.ruff]
+line-length = 100
+src = ["src"]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+files = ["src/backlex"]

backlex-0.0.1/src/backlex/__init__.py

@@ -0,0 +1,46 @@
+"""backlex — official Python client.
+
+    from backlex import create_client
+
+    client = create_client("https://api.example.com", api_key="pak_...")
+    posts = client.from_("posts").query().where(lambda f: f.eq("published", True)).list()
+"""
+
+from __future__ import annotations
+
+from .client import Auth, Client, Collection, Storage, create_client
+from .errors import BacklexError
+from .query import FilterBuilder, QueryBuilder, normalize_condition
+from .types import (
+    AuthResult,
+    AuthUser,
+    Condition,
+    Item,
+    ItemEvent,
+    ItemResponse,
+    ListQuery,
+    ListResponse,
+)
+
+__version__ = "0.0.1"
+
+__all__ = [
+    "create_client",
+    "Client",
+    "Collection",
+    "Auth",
+    "Storage",
+    "QueryBuilder",
+    "FilterBuilder",
+    "normalize_condition",
+    "BacklexError",
+    "Condition",
+    "Item",
+    "ItemEvent",
+    "ItemResponse",
+    "ListQuery",
+    "ListResponse",
+    "AuthResult",
+    "AuthUser",
+    "__version__",
+]