surreal-orm-lite 0.2.0__tar.gz

surreal_orm_lite-0.2.0/.gitignore

@@ -0,0 +1,80 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+.windsurfrules
+
+# C extensions
+*.so
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+MANIFEST
+wheels/
+*.whl
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+coverage.xml
+junit.xml
+*.cover
+*.py,cover
+.pytest_cache/
+.hypothesis/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Environment directories
+.env
+.dev-venv
+.venv
+.venv*/
+env/
+venv/
+ENV/
+
+# IDE settings
+.idea/
+.vscode/
+*.swp
+*.swo
+.project
+.pydevproject
+.settings/
+*.sublime-workspace
+*.sublime-project
+
+# Logs and databases
+*.log
+*.sqlite
+*.db
+surreal_data/
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Project specific
+external_pkg_ref/
+*.bak
+*.tmp
+.mypy_cache/
+.ruff_cache/
+.dmypy.json
+dmypy.json
+
+.claude/

surreal_orm_lite-0.2.0/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-02-02
+
+### Added
+
+- Initial release of **Surreal ORM Lite**
+- Support for official SurrealDB Python SDK 1.0.8
+- Compatibility with SurrealDB 2.6.0
+- Django-style ORM with `BaseSurrealModel` base class
+- `QuerySet` with fluent query builder
+- Filter lookups: `exact`, `gt`, `gte`, `lt`, `lte`, `in`, `contains`, `startswith`, etc.
+- CRUD operations: `save()`, `update()`, `merge()`, `delete()`, `refresh()`
+- `SurrealDBConnectionManager` for connection management
+- HTTP and WebSocket connection support
+- Custom primary key configuration via `SurrealConfigDict`
+- Pydantic 2.x validation support
+- Custom exceptions: `SurrealDbError`, `SurrealDbConnectionError`, etc.
+- Full async/await support
+- 97%+ test coverage
+
+### Changed
+
+- Migrated from custom SDK to official SurrealDB SDK 1.0.8
+- Updated API to match SDK 1.0.8 response formats
+- `signin()` now uses dictionary format: `{"username": ..., "password": ...}`
+
+### Fixed
+
+- Handle SDK 1.0.8 returning lists for single record `select()`
+- Handle SDK 1.0.8 returning error strings instead of exceptions
+- Escape special characters in record IDs (e.g., `@` in email addresses)
+
+## [0.1.x] - Previous Versions
+
+Previous versions were part of the SurrealDB-ORM project with a custom SDK implementation. This project (Surreal ORM Lite) is a fork focused on using the official SDK only.

surreal_orm_lite-0.2.0/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.

surreal_orm_lite-0.2.0/Makefile

@@ -0,0 +1,48 @@
+.DEFAULT_GOAL := all
+sources = src
+
+.PHONY: .uv  # Check that uv is installed
+.uv:
+	@uv --version || echo 'Please install uv: https://docs.astral.sh/uv/getting-started/installation/'
+
+.PHONY: install  # Install the package, dependencies, and pre-commit for local development
+install: .uv
+	uv sync --frozen --group lint
+	uv run pre-commit install --install-hooks
+
+.PHONY: format  # Format the code
+format:
+	uv run ruff format
+	uv run ruff check --fix --fix-only
+
+.PHONY: lint  # Lint the code
+lint:
+	uv run ruff format --check
+	uv run ruff check
+
+.PHONY: mypy
+mypy:
+	uv run python -m mypy $(sources)
+
+.PHONY: typecheck
+typecheck:
+	uv run pyright
+
+.PHONY: test
+test:
+	uv run pytest
+
+.PHONY: test-all-python  # Run tests on Python 3.11 to 3.13
+test-all-python:
+	uv run --python 3.11 coverage run -p -m pytest --junitxml=junit.xml -o junit_family=legacy
+	UV_PROJECT_ENVIRONMENT=.venv312 uv run --python 3.12 coverage run -p -m pytest
+	UV_PROJECT_ENVIRONMENT=.venv313 uv run --python 3.13 coverage run -p -m pytest
+	@uv run coverage xml -o coverage.xml
+	@uv run coverage report
+
+.PHONY: html  # Generate HTML coverage report
+html: test-all-python
+	uv run coverage html -d htmlcov
+
+.PHONY: all
+all: format mypy lint typecheck test-all-python

surreal_orm_lite-0.2.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,233 @@
+# 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