duckling-orm 0.0.3__py3-none-any.whl

duckling_orm-0.0.3.dist-info/METADATA

@@ -0,0 +1,349 @@
+Metadata-Version: 2.4
+Name: duckling-orm
+Version: 0.0.3
+Summary: A Beanie-inspired ORM for DuckDB — async-first, Pydantic-powered.
+Author: Duckling Contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/carbonbits/duckling
+Project-URL: Repository, https://github.com/carbonbits/duckling
+Project-URL: Issues, https://github.com/carbonbits/duckling/issues
+Keywords: duckdb,orm,pydantic,async,beanie
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: duckdb>=0.9.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: pre-commit>=3.5; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# 🦆 Duckling
+
+**A Beanie-inspired ORM for DuckDB — async-first, Pydantic-powered.**
+
+Duckling brings the elegant, developer-friendly API of [Beanie](https://github.com/BeanieODM/beanie) (MongoDB ODM) to [DuckDB](https://duckdb.org/) — the fast, in-process analytical database. Define your models with Pydantic, query with Pythonic expressions, and enjoy both async and sync APIs.
+
+The original version of this project was generated by Claude AI.
+
+The human intervention in the code is to customize it for use within the carbonbits ecosystem. No plans to publish to pypi yet
+
+## Installation
+
+```bash
+pip install duckling
+# or from source:
+pip install -e .
+```
+
+**Requirements:** Python ≥ 3.10, `duckdb >= 0.9`, `pydantic >= 2.0`
+
+---
+
+## Quick Start
+
+```python
+import asyncio
+from typing import Annotated, Optional
+from duckling import Document, IndexSpec, init_duckling
+
+class User(Document):
+    name: str
+    email: Annotated[str, IndexSpec(unique=True)]
+    age: int = 0
+
+    class Settings:
+        table_name = "users"
+
+async def main():
+    await init_duckling(database=":memory:", document_models=[User])
+
+    # Insert
+    alice = User(name="Alice", email="alice@example.com", age=30)
+    await alice.insert()
+
+    # Query
+    users = await User.find(User.age > 25).sort("+name").limit(10).to_list()
+
+    # Update
+    alice.age = 31
+    await alice.save()
+
+    # Delete
+    await alice.delete()
+
+asyncio.run(main())
+```
+
+---
+
+## API Reference
+
+### Initialization
+
+```python
+from duckling import init_duckling, init_duckling_sync
+
+# Async
+await init_duckling(
+    database=":memory:",          # or "path/to/file.db"
+    document_models=[User, Product],
+    recreate_tables=False,        # drop & recreate tables
+)
+
+# Sync
+init_duckling_sync(database="app.db", document_models=[User])
+```
+
+### Defining Models
+
+Duckling models are Pydantic `BaseModel` subclasses with an auto-generated `id` primary key:
+
+```python
+from duckling import Document, IndexSpec
+from typing import Annotated, Optional, List
+import datetime
+
+class Product(Document):
+    name: str
+    price: float
+    category: Optional[str] = None
+    tags: Optional[List[str]] = None       # stored as JSON
+    created_at: datetime.datetime = datetime.datetime.now()
+    in_stock: bool = True
+
+    class Settings:
+        table_name = "products"   # optional, auto-generated from class name
+```
+
+**Supported types:** `str`, `int`, `float`, `bool`, `bytes`, `datetime.date`, `datetime.datetime`, `datetime.time`, `uuid.UUID`, `Optional[T]`, `List[T]` (→ JSON), `dict` (→ JSON), nested Pydantic models (→ JSON), `Enum`.
+
+### Indexed Fields
+
+```python
+from duckling import IndexSpec
+from typing import Annotated
+
+class User(Document):
+    email: Annotated[str, IndexSpec(unique=True)]   # unique index
+    age: Annotated[int, IndexSpec()]                 # regular index
+```
+
+### CRUD Operations
+
+Every method has an async version (default) and a `_sync` variant:
+
+| Async | Sync | Description |
+|---|---|---|
+| `await doc.insert()` | `doc.insert_sync()` | Insert a new document |
+| `await doc.save()` | `doc.save_sync()` | Upsert (insert or update) |
+| `await doc.delete()` | `doc.delete_sync()` | Delete this document |
+| `await doc.refresh()` | — | Reload from database |
+| `await Model.insert_many([...])` | `Model.insert_many_sync([...])` | Bulk insert |
+| `await Model.delete_all()` | `Model.delete_all_sync()` | Delete all rows |
+| `await Model.get(id)` | `Model.get_sync(id)` | Fetch by primary key |
+| `await Model.count()` | `Model.count_sync()` | Count all rows |
+
+### Queries
+
+Duckling's query interface mirrors Beanie's fluent API:
+
+```python
+# Find with conditions
+users = await User.find(User.age > 25).to_list()
+users = await User.find(User.age > 25, User.active == True).to_list()
+
+# Find one
+user = await User.find_one(User.email == "alice@example.com")
+
+# Find all
+all_users = await User.find_all().to_list()
+
+# Chaining
+results = (
+    await User.find(User.active == True)
+    .find(User.age >= 18)          # additional conditions (AND)
+    .sort("+name")                  # ascending
+    .sort("-age")                   # descending
+    .skip(10)                       # offset
+    .limit(20)                      # limit
+    .to_list()
+)
+
+# Count & exists
+count = await User.find(User.age > 30).count()
+has_any = await User.find(User.name == "Alice").exists()
+
+# Async iteration
+async for user in User.find(User.active == True).sort("+name"):
+    print(user.name)
+```
+
+### Query Expressions
+
+Use Pythonic operators directly on model fields:
+
+```python
+# Comparison operators
+User.age == 30          User.age != 30
+User.age > 25           User.age >= 25
+User.age < 40           User.age <= 40
+
+# Boolean combinators
+(User.age > 25) & (User.active == True)    # AND
+(User.name == "A") | (User.name == "B")    # OR
+~(User.active == True)                      # NOT
+
+# FieldProxy helper methods
+User.name.startswith("Ali")     # LIKE 'Ali%'
+User.name.endswith("son")       # LIKE '%son'
+User.name.contains("lic")       # LIKE '%lic%'
+User.name.like("A%e")           # LIKE 'A%e'
+User.name.ilike("alice")        # ILIKE (case-insensitive)
+User.age.is_in([25, 30, 35])    # IN (25, 30, 35)
+User.age.not_in([0, 99])        # NOT IN
+User.age.between(18, 65)        # BETWEEN 18 AND 65
+
+# Sort helpers
+User.name.asc()     # → ("name", ASCENDING)
+User.name.desc()    # → ("name", DESCENDING)
+```
+
+### Operator Functions
+
+For more complex queries, use the operator functions:
+
+```python
+from duckling.operators import And, Or, Not, In, NotIn, Between, Like, ILike, Raw
+
+await User.find(In(User.age, [25, 30, 35])).to_list()
+await User.find(Between(User.age, 18, 65)).to_list()
+await User.find(Like(User.name, "%smith%")).to_list()
+
+# Combine
+await User.find(
+    And(
+        User.active == True,
+        Or(User.city == "NYC", User.city == "LA"),
+        Not(User.age < 18),
+    )
+).to_list()
+
+# Raw SQL escape hatch
+await User.find(Raw('"age" % 2 = 0')).to_list()
+```
+
+### Aggregation
+
+```python
+from duckling.query import Count, Sum, Avg, Min, Max, CountDistinct
+
+stats = await User.find(User.active == True).aggregate(
+    total=Count(),
+    avg_age=Avg("age"),
+    max_age=Max("age"),
+    min_age=Min("age"),
+    sum_age=Sum("age"),
+    unique_names=CountDistinct("name"),
+)
+print(stats)  # {'total': 42, 'avg_age': 31.5, ...}
+```
+
+### Sort Syntax
+
+```python
+# String syntax
+.sort("+name")          # ascending
+.sort("-age")           # descending
+.sort("+name", "-age")  # multi-column
+
+# Tuple syntax
+.sort(("name", SortDirection.ASCENDING))
+
+# FieldProxy syntax
+.sort(User.name.asc(), User.age.desc())
+```
+
+### Transactions
+
+```python
+session = get_session()
+
+# Async
+async with session.async_transaction():
+    await user.insert()
+    await order.insert()
+
+# Sync
+with session.transaction():
+    user.insert_sync()
+    order.insert_sync()
+```
+
+### Raw SQL Escape Hatch
+
+```python
+from duckling import get_session
+
+session = get_session()
+
+# Async
+rows = await session.async_fetchall("SELECT * FROM users WHERE age > ?", [25])
+
+# Get pandas DataFrame
+df = await session.async_fetchdf("SELECT name, age FROM users")
+
+# Sync
+rows = session.fetchall("SELECT count(*) FROM users")
+```
+
+---
+
+## Beanie → Duckling Comparison
+
+| Beanie (MongoDB) | Duckling (DuckDB) |
+|---|---|
+| `init_beanie(database, models)` | `await init_duckling(database, models)` |
+| `class User(Document)` | `class User(Document)` |
+| `await user.insert()` | `await user.insert()` |
+| `await user.save()` | `await user.save()` |
+| `await User.find(cond).to_list()` | `await User.find(cond).to_list()` |
+| `await User.find_one(cond)` | `await User.find_one(cond)` |
+| `User.name == "Alice"` | `User.name == "Alice"` |
+| `In(User.age, [...])` | `In(User.age, [...])` |
+| `await User.find().sort("+name")` | `await User.find().sort("+name")` |
+| Settings class | Settings class |
+| `Indexed(str, unique=True)` | `Annotated[str, IndexSpec(unique=True)]` |
+
+---
+
+## Project Structure
+
+```
+src/duckling/
+├── __init__.py         # Public exports
+├── connection.py       # DuckDB session management
+├── document.py         # Document base class (the core)
+├── fields.py           # FieldProxy, Indexed, Expression types
+├── init.py             # init_duckling() / init_duckling_sync()
+├── operators.py        # And, Or, In, Between, Like, etc.
+├── query.py            # FindQuery builder + aggregation
+└── exceptions.py       # Custom exceptions
+
+tests/                  # Per-module tests (test_document.py, test_query.py, …)
+```
+
+## License
+
+MIT

duckling_orm-0.0.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+duckling/__init__.py,sha256=f25GgRRC4wu8VRnxur4LTv0uVrnJ7lYnTev7F30L6wY,2088
+duckling/connection.py,sha256=5uCzHAz18j8e2kZNEyts_TUO_ZSlWQuz5WwGVYFAIZ4,5782
+duckling/document.py,sha256=OrNzSzu76zA4VI39wAHOI_0_I6VnM5vXpvVKW_-L7Cs,19554
+duckling/exceptions.py,sha256=zR-43m_X4v6DhWzmOZJFRlLWnA8YMT3p9fyaJCSRstU,795
+duckling/fields.py,sha256=Ei-cy-fi9XQE3NQhuHvVY_TERJd_BNQQ8DxT51zYLb8,9161
+duckling/init.py,sha256=MYSTsou3BJsi5Eny_jtc69F3DVkS6b_C2BCwjQJ2Muw,4334
+duckling/operators.py,sha256=yYxBnrWLr9MCuxODID_wDFBB6inkCMKpMEObx2cwVzY,5168
+duckling/query.py,sha256=MGWzrzDorkBL5G-ZJugddRp_4BvlNmFD2LypPATTxS8,12708
+duckling_orm-0.0.3.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+duckling_orm-0.0.3.dist-info/METADATA,sha256=ymRUKqCpZBcCWWzJmb7Gi5WUm-PoRJKkAryBjYD9HvI,9768
+duckling_orm-0.0.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+duckling_orm-0.0.3.dist-info/top_level.txt,sha256=qWhlV7yuZm1uRgSRfW36mjG5Myzb6HeK48rNWHLIe7M,9
+duckling_orm-0.0.3.dist-info/RECORD,,

duckling_orm-0.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

duckling_orm-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

duckling_orm-0.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+duckling