surreal-orm-lite 0.2.0__py3-none-any.whl

surreal_orm_lite-0.2.0.dist-info/METADATA

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: surreal-orm-lite
+Version: 0.2.0
+Summary: Lightweight Django-style ORM for SurrealDB using the official Python SDK. Async support with Pydantic validation.
+Project-URL: Homepage, https://github.com/EulogySnowfall/surreal-orm-lite
+Project-URL: Documentation, https://github.com/EulogySnowfall/surreal-orm-lite
+Project-URL: Repository, https://github.com/EulogySnowfall/surreal-orm-lite.git
+Project-URL: Issues, https://github.com/EulogySnowfall/surreal-orm-lite/issues
+Project-URL: Changelog, https://github.com/EulogySnowfall/surreal-orm-lite/blob/main/CHANGELOG.md
+Author-email: Yannick Croteau <croteau.yannick@gmail.com>
+License: # MIT License
+        
+        Copyright (c) 2024-2026 Yannick Croteau
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: async,database,orm,pydantic,surrealdb
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pydantic :: 2
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: surrealdb>=1.0.8
+Description-Content-Type: text/markdown
+
+# Surreal ORM Lite
+
+![Python](https://img.shields.io/badge/python-3.11%2B-blue)
+![SurrealDB](https://img.shields.io/badge/SurrealDB-2.6.0-purple)
+![SDK](https://img.shields.io/badge/SDK-Official%201.0.8-green)
+![License](https://img.shields.io/badge/license-MIT-blue)
+[![codecov](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM-lite/graph/badge.svg)](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM-lite)
+
+**Surreal ORM Lite** is a lightweight, Django-style ORM for [SurrealDB](https://surrealdb.com/) that uses the **official SurrealDB Python SDK**. It provides a simple and intuitive interface for database operations with full async support and Pydantic validation.
+
+## Why This Project?
+
+This ORM is designed to:
+
+- Use the **official SurrealDB SDK** (`surrealdb>=1.0.8`) for maximum compatibility
+- Stay **lightweight** with minimal dependencies
+- Keep **up-to-date** with SurrealDB and SDK releases
+- Provide **Django-style** query syntax that developers love
+
+---
+
+## Requirements
+
+| Dependency   | Version          |
+| ------------ | ---------------- |
+| Python       | 3.11+            |
+| SurrealDB    | 2.6.0+           |
+| Official SDK | surrealdb>=1.0.8 |
+| Pydantic     | >=2.12.5         |
+
+---
+
+## Installation
+
+```bash
+pip install surreal-orm-lite
+```
+
+Or with uv:
+
+```bash
+uv add surreal-orm-lite
+```
+
+---
+
+## Quick Start
+
+### 1. Configure the Connection
+
+```python
+from surreal_orm_lite import SurrealDBConnectionManager
+
+SurrealDBConnectionManager.set_connection(
+    url="http://localhost:8000",
+    user="root",
+    password="root",
+    namespace="my_namespace",
+    database="my_database",
+)
+```
+
+### 2. Define a Model
+
+```python
+from surreal_orm_lite import BaseSurrealModel
+from pydantic import Field
+
+class User(BaseSurrealModel):
+    id: str | None = None
+    name: str = Field(..., max_length=100)
+    email: str
+    age: int = Field(..., ge=0)
+```
+
+### 3. CRUD Operations
+
+```python
+# Create
+user = User(name="Alice", email="alice@example.com", age=30)
+await user.save()
+
+# Read
+user = await User.objects().get("alice_id")
+users = await User.objects().filter(age__gte=18).exec()
+
+# Update
+user.age = 31
+await user.update()
+
+# Or partial update
+await user.merge(age=31)
+
+# Delete
+await user.delete()
+```
+
+### 4. QuerySet Methods
+
+```python
+# Filter with Django-style lookups
+users = await User.objects().filter(
+    age__gte=18,
+    name__startswith="A"
+).exec()
+
+# Ordering
+users = await User.objects().order_by("name").exec()
+users = await User.objects().order_by("age", OrderBy.DESC).exec()
+
+# Pagination
+users = await User.objects().limit(10).offset(20).exec()
+
+# Select specific fields
+results = await User.objects().select("name", "email").exec()
+
+# Get first result
+user = await User.objects().filter(name="Alice").first()
+
+# Get all records
+all_users = await User.objects().all()
+
+# Custom query
+results = await User.objects().query(
+    "SELECT * FROM User WHERE age > $min_age",
+    {"min_age": 21}
+)
+```
+
+---
+
+## Features
+
+| Feature               | Status |
+| --------------------- | ------ |
+| Async/await support   | ✅     |
+| Pydantic validation   | ✅     |
+| CRUD operations       | ✅     |
+| QuerySet with filters | ✅     |
+| Django-style lookups  | ✅     |
+| Custom primary keys   | ✅     |
+| HTTP connections      | ✅     |
+| WebSocket connections | ✅     |
+
+### Supported Filter Lookups
+
+- `exact` (default)
+- `gt`, `gte`, `lt`, `lte`
+- `in`
+- `contains`, `icontains`
+- `startswith`, `istartswith`
+- `endswith`, `iendswith`
+
+---
+
+## Configuration Options
+
+### Custom Primary Key
+
+```python
+from surreal_orm_lite import BaseSurrealModel, SurrealConfigDict
+
+class Product(BaseSurrealModel):
+    model_config = SurrealConfigDict(primary_key="sku")
+
+    sku: str
+    name: str
+    price: float
+```
+
+### Context Manager
+
+```python
+async with SurrealDBConnectionManager():
+    users = await User.objects().all()
+# Connection automatically closed
+```
+
+---
+
+## Compatibility
+
+This ORM is tested and compatible with:
+
+| SurrealDB Version | SDK Version | Status        |
+| ----------------- | ----------- | ------------- |
+| 2.6.0             | 1.0.8       | ✅ Tested     |
+| 2.5.x             | 1.0.8       | ✅ Compatible |
+
+---
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m "Add amazing feature"`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## Advanced Features?
+
+This project prioritizes **stability and compatibility** with the official SurrealDB Python SDK. Due to current SDK limitations, some advanced features cannot be implemented here.
+
+For a feature-rich ORM with relations, transactions, and more, see:
+
+- **GitHub**: [SurrealDB-ORM](https://github.com/EulogySnowfall/SurrealDB-ORM/)
+- **PyPI**: [surrealdb-orm](https://pypi.org/project/surrealdb-orm/)
+
+When the official SDK supports additional features, they will be incorporated into this lite version.
+
+---
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Yannick Croteau**
+GitHub: [@EulogySnowfall](https://github.com/EulogySnowfall)
+
+---
+
+## Related Projects
+
+- [SurrealDB](https://surrealdb.com/) - The database
+- [surrealdb.py](https://github.com/surrealdb/surrealdb.py) - Official Python SDK

surreal_orm_lite-0.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+surreal_orm_lite/__init__.py,sha256=x2IIvuS9qlW36ynKLCu9OVKdWmRJBU8mL_x4z-EhGjU,602
+surreal_orm_lite/connection_manager.py,sha256=eWW0__ysAxE041y5cRmNXLRU5HR-V7UY6ggP2LnWITs,8915
+surreal_orm_lite/constants.py,sha256=CLavEca1M6cLJLqVl4l4KoE-cBrgVQNsuGxW9zGJBmg,429
+surreal_orm_lite/enum.py,sha256=kR-vzkHqnqy9YaYOvWTwAHdl2-WCzPcSEch-YTyJv1Y,158
+surreal_orm_lite/exceptions.py,sha256=nS0H1zVdiQUq9anQhwjOGZoQbTf93c7_uQbbqfSvKg4,1010
+surreal_orm_lite/model_base.py,sha256=P-Ua1QDXD-SEPiDBIBazX9nU06M7LWZe-Tk7uuYsCic,6633
+surreal_orm_lite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+surreal_orm_lite/query_set.py,sha256=cIKVMzGLKFndXtZuChjJmTGkzT1ocbS72pWWMo9VdXw,18680
+surreal_orm_lite/utils.py,sha256=mni_dTtb4VGTdge8eWSZpBw5xoWci2m-XThKFHYPKTo,171
+surreal_orm_lite-0.2.0.dist-info/METADATA,sha256=W-Bv7U_RI4HIZYmCsqJ1pV1dVm4aHN1PtwEnm9jlHDE,8013
+surreal_orm_lite-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+surreal_orm_lite-0.2.0.dist-info/licenses/LICENSE,sha256=Rvt8jJeCkvea8PDJ6svk6p5oMXzo_EJI1m-Avs1aTlg,1079
+surreal_orm_lite-0.2.0.dist-info/RECORD,,

surreal_orm_lite-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

surreal_orm_lite-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024-2026 Yannick Croteau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.