smart-data-engine-sdk 0.1.0__tar.gz

smart_data_engine_sdk-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+*.egg-info/
+dist/
+build/
+
+# Node, for the TypeScript library
+node_modules/
+typescript/dist/
+
+# Java, Rust
+target/
+.gradle/
+
+# Artefacts that could carry a client's data. A placement map is fine to commit - it names tables,
+# not rows - but anything a running application produced is not, and the cost of being wrong here is
+# not a tidy repository, it is somebody else's data in our history.
+*.profile.json
+telemetry-*.json
+
+# Local configuration and anything holding a key
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+
+# Editors and OS
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db

smart_data_engine_sdk-0.1.0/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 [yyyy] [name of copyright owner]
+
+   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.

smart_data_engine_sdk-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+Smart Data Engine client libraries
+Copyright 2026 Smart Data Engines
+
+This product includes software developed at Smart Data Engines
+(https://smartdataengines.com).
+
+The libraries in this repository are the client side of Smart Data Engine: they
+declare a data model, cache a placement map, route operations and manage schema.
+They connect to database engines directly and they work without an account.
+
+The control plane - the placement planner, the scoring model and the migration
+orchestrator - is a separate, private program and is not covered by this notice
+or by this licence.

smart_data_engine_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.5
+Name: smart-data-engine-sdk
+Version: 0.1.0
+Summary: Smart Data Engine client library: declare a data model, we place it and move it
+Project-URL: Homepage, https://github.com/Smart-Data-Engines/smart-data-engine-sdk
+Project-URL: Repository, https://github.com/Smart-Data-Engines/smart-data-engine-sdk
+Project-URL: Issues, https://github.com/Smart-Data-Engines/smart-data-engine-sdk/issues
+Project-URL: Format contract, https://github.com/Smart-Data-Engines/smart-data-engine-sdk/blob/main/docs/format-contract.md
+Project-URL: Failure semantics, https://github.com/Smart-Data-Engines/smart-data-engine-sdk/blob/main/docs/failure-semantics.md
+Author: Smart Data Engines
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: clickhouse,database,placement,polystore,postgresql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.11
+Provides-Extra: clickhouse
+Requires-Dist: clickhouse-connect>=1.7.2; extra == 'clickhouse'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
+Provides-Extra: signed
+Requires-Dist: cryptography>=42; extra == 'signed'
+Description-Content-Type: text/markdown
+
+# sde — Smart Data Engine client library for Python
+
+Declare your data model. We decide which database engine each part of it lives in, how it is laid out
+there, and when it should move — and move it while your application keeps running.
+
+Your code never names a table or an engine. That absence is the point: it is what lets the physical
+schema change underneath you without touching a line of your code.
+
+```python
+from datetime import datetime
+from decimal import Decimal
+from typing import Annotated
+from uuid import UUID
+import sde
+
+@sde.entity
+class User:
+    id: UUID
+    email: str
+
+    class Meta:
+        pii = ["email"]
+
+@sde.entity
+class Order:
+    id: UUID
+    user: sde.Ref[User]
+    total: Annotated[Decimal, sde.precision(12, 2)]
+    created_at: datetime
+
+    class Meta:
+        residency = "EU"
+
+model = sde.build_model()
+```
+
+## What you declare, and what you do not
+
+You declare entities, relations, and four invariants. Everything else about storage is ours to
+decide.
+
+The four exist because no amount of watching traffic reveals them:
+
+| Declaration | Why traffic cannot tell us |
+|---|---|
+| `atomic_with` | that two entities must commit together is a business rule, not a pattern |
+| `residency` | where data may legally live is not visible in a query |
+| `pii` | which column is personal data determines retention and what may be denormalised |
+| `cost_ceiling` | your budget is not in your workload |
+
+Anything beyond those four and the list of engines you have available would be us handing work back
+to you, which is the opposite of what this is for.
+
+## Two guarantees, and how to check them yourself
+
+**We are not in your data path.** The library connects to your engines directly and answers every
+operation from a locally cached placement map. Our service being down does not make your application
+down. There is no configuration for this — there is no code path that routes your queries through us,
+which you can confirm by reading `routing.py`: it is a dictionary lookup and three conditions.
+
+**We never see a row.** Telemetry carries operation *shapes* and counts, never values, and a shape is
+assembled from the structure of the call rather than from a query string — so there is nowhere for a
+value to come from. This is the reason the library is open source: the guarantee is checkable instead
+of promised.
+
+## It works without an account
+
+Write a placement map by hand, point the library at it, and everything runs: no key, no network, no
+account.
+
+```python
+placement = sde.load_map(json.load(open("placement.json")), model=model)
+```
+
+An unsigned map is valid. A *signed* map with no key to verify it is not, because a signature is a
+claim that it came from us and an unverifiable claim is worse than no claim. This mode is supported
+and tested, not tolerated — it is also the honest answer to what happens if you stop paying us.
+
+## Install
+
+```bash
+pip install smart-data-engine-sdk              # core, no dependencies at all
+pip install 'smart-data-engine-sdk[signed]'    # verify maps we signed
+pip install 'smart-data-engine-sdk[postgres]'  # PostgreSQL engine driver
+```
+
+The core has no runtime dependencies. This library goes into your application, so every dependency
+would be one you inherit and a version conflict you might have to resolve.
+
+**The distribution is `smart-data-engine-sdk` and the import is `sde`, and neither half of that is a
+preference.** `sde` alone is taken on PyPI by somebody else, and renaming the import to a
+squatting-adjacent misspelling is worse for you than a distribution name that differs from it. The
+obvious distribution name, `smart-data-engine`, is *refused by PyPI*: it answers 400, "the name is
+too similar to an existing project". The project is `smartdata-engine`, registered by somebody else
+with zero releases — PyPI compares names after stripping `._-` and folding `l`/`i` to `1` and `o` to
+`0`, and both reduce to `smartdataeng1ne`. The suffix changes the reduction, and it matches the
+repository name, which is the consistency worth having regardless.
+
+Published to PyPI on 12 September 2026. Until then this section was the one instruction in this
+repository that was knowingly untrue, and it carried a warning saying so; the warning is gone because
+the commands work.
+
+## Conformance
+
+Everything in `canonical.py`, `model.py`, `shapes.py` and `routing.py` implements a cross-language
+contract, pinned by vectors in `../conformance/vectors`. The Python, TypeScript, Java and Rust
+libraries run the same vectors in their own test runners, so a divergence is a red test for whoever
+caused it rather than an operation written to the wrong engine in production.
+
+If you are porting this to another language, `docs/format-contract.md` is meant to be sufficient on
+its own. If it is not, that is a bug in the document.
+
+## Licence
+
+Apache-2.0.
+
+## Bound migration verification
+
+Managed cutover uses a `VerificationRequest` from the controller. Configure `Session(...,
+project_id=...)` from your local enrollment manifest, load the request with
+`VerificationRequest.from_record`, and pass it to `verify(..., request=request)`. The returned
+`as_record()` includes the request and counts, while row-level differences remain local.
+See [the request protocol](../docs/format-contract.md#7b-verification-requests-and-bound-reports).
+Loaded placement maps are immutable; load a new document when their layout or routing changes.
+
+Batch operations: [logical bulk writes](../docs/bulk-writes.md) document `save_many` / `saveMany`,
+bounds, source/copy ordering and uncertain outcomes.
+
+[Logical reads and exact summaries](../docs/logical-reads.md) cover scan, count and summarize,
+including portable keyset pages, typed values and explicit failure semantics.
+
+## Local Weather starter
+
+The [Weather starter](https://github.com/Smart-Data-Engines/smart-data-engine-sdk/blob/main/docs/weather-starter.md)
+is part of this package, as the `sde-weather` command. It exercises logical operations with
+restricted runtime credentials, and it includes local setup, telemetry, operator handoffs and an
+ownership-checked reset.
+
+Engine credentials and verified TLS configuration: [connection guide](../docs/engine-connections.md).

smart_data_engine_sdk-0.1.0/README.md

@@ -0,0 +1,139 @@
+# sde — Smart Data Engine client library for Python
+
+Declare your data model. We decide which database engine each part of it lives in, how it is laid out
+there, and when it should move — and move it while your application keeps running.
+
+Your code never names a table or an engine. That absence is the point: it is what lets the physical
+schema change underneath you without touching a line of your code.
+
+```python
+from datetime import datetime
+from decimal import Decimal
+from typing import Annotated
+from uuid import UUID
+import sde
+
+@sde.entity
+class User:
+    id: UUID
+    email: str
+
+    class Meta:
+        pii = ["email"]
+
+@sde.entity
+class Order:
+    id: UUID
+    user: sde.Ref[User]
+    total: Annotated[Decimal, sde.precision(12, 2)]
+    created_at: datetime
+
+    class Meta:
+        residency = "EU"
+
+model = sde.build_model()
+```
+
+## What you declare, and what you do not
+
+You declare entities, relations, and four invariants. Everything else about storage is ours to
+decide.
+
+The four exist because no amount of watching traffic reveals them:
+
+| Declaration | Why traffic cannot tell us |
+|---|---|
+| `atomic_with` | that two entities must commit together is a business rule, not a pattern |
+| `residency` | where data may legally live is not visible in a query |
+| `pii` | which column is personal data determines retention and what may be denormalised |
+| `cost_ceiling` | your budget is not in your workload |
+
+Anything beyond those four and the list of engines you have available would be us handing work back
+to you, which is the opposite of what this is for.
+
+## Two guarantees, and how to check them yourself
+
+**We are not in your data path.** The library connects to your engines directly and answers every
+operation from a locally cached placement map. Our service being down does not make your application
+down. There is no configuration for this — there is no code path that routes your queries through us,
+which you can confirm by reading `routing.py`: it is a dictionary lookup and three conditions.
+
+**We never see a row.** Telemetry carries operation *shapes* and counts, never values, and a shape is
+assembled from the structure of the call rather than from a query string — so there is nowhere for a
+value to come from. This is the reason the library is open source: the guarantee is checkable instead
+of promised.
+
+## It works without an account
+
+Write a placement map by hand, point the library at it, and everything runs: no key, no network, no
+account.
+
+```python
+placement = sde.load_map(json.load(open("placement.json")), model=model)
+```
+
+An unsigned map is valid. A *signed* map with no key to verify it is not, because a signature is a
+claim that it came from us and an unverifiable claim is worse than no claim. This mode is supported
+and tested, not tolerated — it is also the honest answer to what happens if you stop paying us.
+
+## Install
+
+```bash
+pip install smart-data-engine-sdk              # core, no dependencies at all
+pip install 'smart-data-engine-sdk[signed]'    # verify maps we signed
+pip install 'smart-data-engine-sdk[postgres]'  # PostgreSQL engine driver
+```
+
+The core has no runtime dependencies. This library goes into your application, so every dependency
+would be one you inherit and a version conflict you might have to resolve.
+
+**The distribution is `smart-data-engine-sdk` and the import is `sde`, and neither half of that is a
+preference.** `sde` alone is taken on PyPI by somebody else, and renaming the import to a
+squatting-adjacent misspelling is worse for you than a distribution name that differs from it. The
+obvious distribution name, `smart-data-engine`, is *refused by PyPI*: it answers 400, "the name is
+too similar to an existing project". The project is `smartdata-engine`, registered by somebody else
+with zero releases — PyPI compares names after stripping `._-` and folding `l`/`i` to `1` and `o` to
+`0`, and both reduce to `smartdataeng1ne`. The suffix changes the reduction, and it matches the
+repository name, which is the consistency worth having regardless.
+
+Published to PyPI on 12 September 2026. Until then this section was the one instruction in this
+repository that was knowingly untrue, and it carried a warning saying so; the warning is gone because
+the commands work.
+
+## Conformance
+
+Everything in `canonical.py`, `model.py`, `shapes.py` and `routing.py` implements a cross-language
+contract, pinned by vectors in `../conformance/vectors`. The Python, TypeScript, Java and Rust
+libraries run the same vectors in their own test runners, so a divergence is a red test for whoever
+caused it rather than an operation written to the wrong engine in production.
+
+If you are porting this to another language, `docs/format-contract.md` is meant to be sufficient on
+its own. If it is not, that is a bug in the document.
+
+## Licence
+
+Apache-2.0.
+
+## Bound migration verification
+
+Managed cutover uses a `VerificationRequest` from the controller. Configure `Session(...,
+project_id=...)` from your local enrollment manifest, load the request with
+`VerificationRequest.from_record`, and pass it to `verify(..., request=request)`. The returned
+`as_record()` includes the request and counts, while row-level differences remain local.
+See [the request protocol](../docs/format-contract.md#7b-verification-requests-and-bound-reports).
+Loaded placement maps are immutable; load a new document when their layout or routing changes.
+
+Batch operations: [logical bulk writes](../docs/bulk-writes.md) document `save_many` / `saveMany`,
+bounds, source/copy ordering and uncertain outcomes.
+
+[Logical reads and exact summaries](../docs/logical-reads.md) cover scan, count and summarize,
+including portable keyset pages, typed values and explicit failure semantics.
+
+## Local Weather starter
+
+The [Weather starter](https://github.com/Smart-Data-Engines/smart-data-engine-sdk/blob/main/docs/weather-starter.md)
+is part of this package, as the `sde-weather` command. It exercises logical operations with
+restricted runtime credentials, and it includes local setup, telemetry, operator handoffs and an
+ownership-checked reset.
+
+Engine credentials and verified TLS configuration: [connection guide](../docs/engine-connections.md).