nextorm 0.1.0__tar.gz

nextorm-0.1.0/LICENSE

@@ -0,0 +1,179 @@
+
+                                 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
+
+   Copyright 2026 Henri Hulski

nextorm-0.1.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.1
+Name: nextorm
+Version: 0.1.0
+Summary: Modern Python ORM with async support, full type annotations and a generator-expression query DSL
+Keywords: orm,async,database,sqlite,postgresql,mariadb,ponyorm
+Author-Email: Henri Hulski <henri@sancode.it>
+License: Apache-2.0
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://github.com/sancode/nextorm
+Project-URL: Repository, https://github.com/sancode/nextorm
+Project-URL: Documentation, https://nextorm.readthedocs.io/en/latest/
+Project-URL: Changelog, https://github.com/sancode/nextorm/blob/main/CHANGELOG.md
+Requires-Python: >=3.12
+Provides-Extra: sqlite
+Requires-Dist: aiosqlite>=0.20; extra == "sqlite"
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]>=3.2; extra == "postgres"
+Provides-Extra: mariadb
+Requires-Dist: PyMySQL>=1.1; extra == "mariadb"
+Requires-Dist: asyncmy>=0.2; extra == "mariadb"
+Description-Content-Type: text/markdown
+
+# NextORM
+
+[![CI](https://github.com/sancode/nextorm/actions/workflows/ci.yml/badge.svg)](https://github.com/sancode/nextorm/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/nextorm)](https://pypi.org/project/nextorm/)
+[![Python](https://img.shields.io/pypi/pyversions/nextorm)](https://pypi.org/project/nextorm/)
+[![License](https://img.shields.io/pypi/l/nextorm)](LICENSE)
+[![Docs](https://readthedocs.org/projects/nextorm/badge/?version=latest)](https://nextorm.readthedocs.io/en/latest/)
+
+Modern Python ORM with async support, full type annotations and a generator-expression query DSL.
+
+## Features
+
+- **Type-annotated fields** &mdash; `PK[int]`, `Req[str]`, `Opt[str]`, `Set[T]`, `Single[T]`
+- **Auto-save sessions** &mdash; create entities inside `db_session` and they are committed automatically
+- **PonyORM-compatible DSL** &mdash; generator-expression queries, `Entity[pk]`, `Entity.get()`, lifecycle hooks
+- **Full async support** &mdash; `AsyncDatabase`, `await db.aselect(...)`, `Entity.aselect()`, `Entity.aget()`
+- **Built-in migrations CLI** &mdash; `nextorm makemigrations` / `nextorm migrate`
+- **Three providers** &mdash; SQLite, PostgreSQL (psycopg3), MariaDB
+- **100% branch coverage** enforced in CI
+
+## Installation
+
+```bash
+pip install nextorm[sqlite]        # SQLite (aiosqlite)
+pip install nextorm[postgres]      # PostgreSQL (psycopg3)
+pip install nextorm[mariadb]       # MariaDB (asyncmy + PyMySQL)
+pip install "nextorm[sqlite,postgres,mariadb]"   # all drivers
+```
+
+## Quick start
+
+```python
+from nextorm import Database, Entity, PK, Req, Opt, Set, Single, db_session
+
+# Define entities — no database coupling required
+class Tag(Entity):
+    name: Req[str]
+
+class Product(Entity):
+    name:  Req[str]
+    price: Req[float]
+    tags:  Set[Tag]    # many-to-many
+
+# Create and connect the database
+db = Database(entities=[Tag, Product])
+db.bind("sqlite", ":memory:")
+db.generate_mapping(create_tables=True)
+
+# Write — entities are tracked and committed automatically
+with db_session:
+    t = Tag(name="sale")
+    p = Product(name="Widget", price=9.99)
+    p.tags.add(t)
+# ← INSERT fires here; p.id and t.id are now set
+
+# Read — class-level shortcuts (no explicit db reference needed)
+widgets = Product.select().filter(Product.price < 20).fetch_all()
+widget  = Product.get(name="Widget")   # None if not found
+widget  = Product[1]                   # KeyError if not found
+```
+
+## Async quick start
+
+```python
+import asyncio
+from nextorm import AsyncDatabase, Entity, PK, Req, db_session
+
+class Task(Entity):
+    title: Req[str]
+    done:  Req[bool]
+
+async def main() -> None:
+    db = AsyncDatabase(entities=[Task])
+    await db.bind("sqlite", ":memory:")
+    await db.generate_mapping(create_tables=True)
+
+    async with db_session:
+        Task(title="Buy milk", done=False)
+
+    pending = await Task.aselect().filter(Task.done == False).fetch_all()
+    task    = await Task.aget(title="Buy milk")   # None if not found
+    print(pending)
+
+asyncio.run(main())
+```
+
+## Migrations
+
+```bash
+nextorm makemigrations   # generate a migration from model changes
+nextorm migrate          # apply pending migrations
+nextorm showmigrations   # list migration history
+```
+
+## Migrating from PonyORM
+
+NextORM's API is intentionally close to PonyORM's. The main differences:
+
+| PonyORM | NextORM |
+|---|---|
+| `class Product(db.Entity)` | `class Product(Entity)` |
+| `Required(str)` | `Req[str]` |
+| `Optional(str)` | `Opt[str]` |
+| `PrimaryKey(int, auto=True)` | `PK[int]` |
+| `Required(Order)` (FK side) | `Single[Order]` |
+| `Set("Line")` (back-reference) | `Set["Line"]` |
+| `select(p for p in Product if ...)` | identical |
+| `Product[42]` | identical |
+| `Product.get(name="x")` | identical |
+| `db.save(p)` required | auto-committed in `db_session` |
+
+See the [migration guide](https://nextorm.readthedocs.io/en/latest/ponyorm.html) for details.
+
+## Documentation
+
+Full docs at **[nextorm.readthedocs.io](https://nextorm.readthedocs.io/en/latest/)**.
+
+## Development
+
+```bash
+pdm install
+pdm test          # run tests
+pdm coverage      # tests + branch coverage (must be 100%)
+pdm typecheck     # pyright + mypy
+pdm lint          # ruff
+pdm format        # ruff format
+pdm docs-html     # build Sphinx docs
+```
+
+## Acknowledgements
+
+NextORM's API design and query DSL are heavily inspired by
+[PonyORM](https://ponyorm.org), created by Alexander Kozlovsky, Alexey Malashkevich,
+and Alexander Tischenko, released under the Apache License 2.0.
+NextORM is a new, independent implementation and shares no source code with PonyORM.

nextorm-0.1.0/README.md

@@ -0,0 +1,135 @@
+# NextORM
+
+[![CI](https://github.com/sancode/nextorm/actions/workflows/ci.yml/badge.svg)](https://github.com/sancode/nextorm/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/nextorm)](https://pypi.org/project/nextorm/)
+[![Python](https://img.shields.io/pypi/pyversions/nextorm)](https://pypi.org/project/nextorm/)
+[![License](https://img.shields.io/pypi/l/nextorm)](LICENSE)
+[![Docs](https://readthedocs.org/projects/nextorm/badge/?version=latest)](https://nextorm.readthedocs.io/en/latest/)
+
+Modern Python ORM with async support, full type annotations and a generator-expression query DSL.
+
+## Features
+
+- **Type-annotated fields** — `PK[int]`, `Req[str]`, `Opt[str]`, `Set[T]`, `Single[T]`
+- **Auto-save sessions** — create entities inside `db_session` and they are committed automatically
+- **PonyORM-compatible DSL** — generator-expression queries, `Entity[pk]`, `Entity.get()`, lifecycle hooks
+- **Full async support** — `AsyncDatabase`, `await db.aselect(...)`, `Entity.aselect()`, `Entity.aget()`
+- **Built-in migrations CLI** — `nextorm makemigrations` / `nextorm migrate`
+- **Three providers** — SQLite, PostgreSQL (psycopg3), MariaDB
+- **100% branch coverage** enforced in CI
+
+## Installation
+
+```bash
+pip install nextorm[sqlite]        # SQLite (aiosqlite)
+pip install nextorm[postgres]      # PostgreSQL (psycopg3)
+pip install nextorm[mariadb]       # MariaDB (asyncmy + PyMySQL)
+pip install "nextorm[sqlite,postgres,mariadb]"   # all drivers
+```
+
+## Quick start
+
+```python
+from nextorm import Database, Entity, PK, Req, Opt, Set, Single, db_session
+
+# Define entities — no database coupling required
+class Tag(Entity):
+    name: Req[str]
+
+class Product(Entity):
+    name:  Req[str]
+    price: Req[float]
+    tags:  Set[Tag]    # many-to-many
+
+# Create and connect the database
+db = Database(entities=[Tag, Product])
+db.bind("sqlite", ":memory:")
+db.generate_mapping(create_tables=True)
+
+# Write — entities are tracked and committed automatically
+with db_session:
+    t = Tag(name="sale")
+    p = Product(name="Widget", price=9.99)
+    p.tags.add(t)
+# ← INSERT fires here; p.id and t.id are now set
+
+# Read — class-level shortcuts (no explicit db reference needed)
+widgets = Product.select().filter(Product.price < 20).fetch_all()
+widget  = Product.get(name="Widget")   # None if not found
+widget  = Product[1]                   # KeyError if not found
+```
+
+## Async quick start
+
+```python
+import asyncio
+from nextorm import AsyncDatabase, Entity, PK, Req, db_session
+
+class Task(Entity):
+    title: Req[str]
+    done:  Req[bool]
+
+async def main() -> None:
+    db = AsyncDatabase(entities=[Task])
+    await db.bind("sqlite", ":memory:")
+    await db.generate_mapping(create_tables=True)
+
+    async with db_session:
+        Task(title="Buy milk", done=False)
+
+    pending = await Task.aselect().filter(Task.done == False).fetch_all()
+    task    = await Task.aget(title="Buy milk")   # None if not found
+    print(pending)
+
+asyncio.run(main())
+```
+
+## Migrations
+
+```bash
+nextorm makemigrations   # generate a migration from model changes
+nextorm migrate          # apply pending migrations
+nextorm showmigrations   # list migration history
+```
+
+## Migrating from PonyORM
+
+NextORM's API is intentionally close to PonyORM's. The main differences:
+
+| PonyORM | NextORM |
+|---|---|
+| `class Product(db.Entity)` | `class Product(Entity)` |
+| `Required(str)` | `Req[str]` |
+| `Optional(str)` | `Opt[str]` |
+| `PrimaryKey(int, auto=True)` | `PK[int]` |
+| `Required(Order)` (FK side) | `Single[Order]` |
+| `Set("Line")` (back-reference) | `Set["Line"]` |
+| `select(p for p in Product if ...)` | identical |
+| `Product[42]` | identical |
+| `Product.get(name="x")` | identical |
+| `db.save(p)` required | auto-committed in `db_session` |
+
+See the [migration guide](https://nextorm.readthedocs.io/en/latest/ponyorm.html) for details.
+
+## Documentation
+
+Full docs at **[nextorm.readthedocs.io](https://nextorm.readthedocs.io/en/latest/)**.
+
+## Development
+
+```bash
+pdm install
+pdm test          # run tests
+pdm coverage      # tests + branch coverage (must be 100%)
+pdm typecheck     # pyright + mypy
+pdm lint          # ruff
+pdm format        # ruff format
+pdm docs-html     # build Sphinx docs
+```
+
+## Acknowledgements
+
+NextORM's API design and query DSL are heavily inspired by
+[PonyORM](https://ponyorm.org), created by Alexander Kozlovsky, Alexey Malashkevich,
+and Alexander Tischenko, released under the Apache License 2.0.
+NextORM is a new, independent implementation and shares no source code with PonyORM.