surrealdb-orm 0.1.0__tar.gz

surrealdb_orm-0.1.0/.gitignore

@@ -0,0 +1,79 @@
+# 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
+*.ipynb
+
+# 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

surrealdb_orm-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 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.

surrealdb_orm-0.1.0/Makefile

@@ -0,0 +1,44 @@
+.DEFAULT_GOAL := all
+sources = src tests
+
+.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: 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 lint typecheck test-all-python

surrealdb_orm-0.1.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: surrealdb-orm
+Version: 0.1.0
+Summary: SurrealDB ORM as 'DJango style' for Python with async support. Works with pydantic validation.
+Project-URL: Homepage, https://github.com/EulogySnowfall/SurrealDB-ORM
+Project-URL: Documentation, https://github.com/EulogySnowfall/SurrealDB-ORM
+Project-URL: Repository, https://github.com/EulogySnowfall/SurrealDB-ORM.git
+Project-URL: Issues, https://github.com/EulogySnowfall/SurrealDB-ORM/issues
+Author-email: Yannick Croteau <yannick.croteau@gmail.com>
+License: # MIT License
+        
+        Copyright (c) 2024 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
+Classifier: Development Status :: 3 - Alpha
+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: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.10.4
+Requires-Dist: surrealdb>=0.4.1
+Description-Content-Type: text/markdown
+
+# SurrealDB-ORM
+
+![Python](https://img.shields.io/badge/python-3.11%2B-blue)
+![CI](https://github.com/EulogySnowfall/SurrealDB-ORM/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM/graph/badge.svg?token=XUONTG2M6Z)](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM)
+![GitHub License](https://img.shields.io/github/license/EulogySnowfall/SurrealDB-ORM)
+
+🚀 **SurrealDB-ORM** is a lightweight ORM (Object-Relational Mapping) inspired by Django ORM, designed to simplify interactions with **SurrealDB** in Python projects. It provides an intuitive way to manage models, perform queries, and execute CRUD (Create, Read, Update, Delete) operations.
+
+---
+
+## 📋 Table of Contents
+
+- [Version](#-version)
+- [Description](#-description)
+- [Requirements and tested based](#-requirements-and-tested-based)
+- [Installation](#-installation)
+- [Usage Example](#-usage-example)
+- [Features](#-features)
+- [Contributing](#-contributing)
+- [TODO](#-todo)
+- [License](#-license)
+
+---
+
+## :white_check_mark: Version
+
+Alpha 0.1.0
+
+---
+
+## 📝 Description
+
+SurrealDB-ORM offers a clean abstraction for handling SurrealDB through Python models.  
+The goal is to simplify writing complex queries while providing an intuitive interface similar to modern ORMs like Django or SQLAlchemy.
+
+---
+
+## 📝 Requirements and tested based
+
+- Python : 3.11~3.13
+- Pydantic : 2.10.4
+- SurrealDB Database Version : 2.1.4
+- You need to set a SurrealDB to connect to.  
+
+---
+
+## 🛠️ Installation
+
+```bash
+pip install surrealdb-orm
+```
+
+---
+
+## 🚀 Usage Example
+
+Here's a simple example demonstrating how to define a model and interact with SurrealDB:
+
+### 1. Define a Model
+
+```python
+from surreal_orm.modelBase import BaseSurrealModel
+from pydantic import BaseModel, Field
+from typing import Optional
+
+
+class User(BaseSurrealModel):
+    id: Optional[str] = None
+    name: str = Field(..., max_length=100)
+    email: str
+```
+
+### 2. Create and Save a User
+
+```python
+user = User(name="Alice", email="alice@example.com")
+await user.save()
+```
+
+### 3. Query Users
+
+```python
+users = await User.objects().filter(name="Alice").exec()
+for user in users:
+    print(user.name, user.email)
+```
+
+---
+
+## 🌟 Features
+
+- 🔧 **Model definition** using Pydantic  
+- 📄 **QuerySet** with filter methods like `filter()`, `limit()`, and `order_by()`  
+- 🔄 **CRUD** operations (Create, Read, Update, Delete)  
+- ⚙️ **Asynchronous connection** to SurrealDB  
+- 🔍 **Automatic validation** with Pydantic  
+- 📊 **Complex queries** with conditional filters (`age__gte`, `name__in`, etc.)  
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!  
+If you'd like to improve this project:
+
+1. Fork the repository.  
+2. Create a branch (`git checkout -b feature/new-feature`).  
+3. Make your changes and commit them (`git commit -m "Add new feature"`).  
+4. Push to your branch (`git push origin feature/new-feature`).  
+5. Create a Pull Request.  
+
+---
+
+## 📌 TODO
+
+- [ ] Implement relationships
+- [ ] Add transaction support  
+- [ ] Optimize complex queries  
+- [ ] Expand documentation with advanced examples  
+- [ ] Better SurrealQL Integration
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License**. See the `LICENSE` file for more information.
+
+---
+
+### 📨 Contact
+
+**Author:** Yannick Croteau  
+**Email:** <croteau.yannick@gmail.com>  
+**GitHub:** [EulogySnowfall](https://github.com/EulogySnowfall)  
+
+---
+
+**SurrealDB-ORM** is a personal package to use with other projects. I will certainly improve it over the next few months, but feel free to open issues or suggest improvements 🚀

surrealdb_orm-0.1.0/README.md

@@ -0,0 +1,139 @@
+# SurrealDB-ORM
+
+![Python](https://img.shields.io/badge/python-3.11%2B-blue)
+![CI](https://github.com/EulogySnowfall/SurrealDB-ORM/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM/graph/badge.svg?token=XUONTG2M6Z)](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM)
+![GitHub License](https://img.shields.io/github/license/EulogySnowfall/SurrealDB-ORM)
+
+🚀 **SurrealDB-ORM** is a lightweight ORM (Object-Relational Mapping) inspired by Django ORM, designed to simplify interactions with **SurrealDB** in Python projects. It provides an intuitive way to manage models, perform queries, and execute CRUD (Create, Read, Update, Delete) operations.
+
+---
+
+## 📋 Table of Contents
+
+- [Version](#-version)
+- [Description](#-description)
+- [Requirements and tested based](#-requirements-and-tested-based)
+- [Installation](#-installation)
+- [Usage Example](#-usage-example)
+- [Features](#-features)
+- [Contributing](#-contributing)
+- [TODO](#-todo)
+- [License](#-license)
+
+---
+
+## :white_check_mark: Version
+
+Alpha 0.1.0
+
+---
+
+## 📝 Description
+
+SurrealDB-ORM offers a clean abstraction for handling SurrealDB through Python models.  
+The goal is to simplify writing complex queries while providing an intuitive interface similar to modern ORMs like Django or SQLAlchemy.
+
+---
+
+## 📝 Requirements and tested based
+
+- Python : 3.11~3.13
+- Pydantic : 2.10.4
+- SurrealDB Database Version : 2.1.4
+- You need to set a SurrealDB to connect to.  
+
+---
+
+## 🛠️ Installation
+
+```bash
+pip install surrealdb-orm
+```
+
+---
+
+## 🚀 Usage Example
+
+Here's a simple example demonstrating how to define a model and interact with SurrealDB:
+
+### 1. Define a Model
+
+```python
+from surreal_orm.modelBase import BaseSurrealModel
+from pydantic import BaseModel, Field
+from typing import Optional
+
+
+class User(BaseSurrealModel):
+    id: Optional[str] = None
+    name: str = Field(..., max_length=100)
+    email: str
+```
+
+### 2. Create and Save a User
+
+```python
+user = User(name="Alice", email="alice@example.com")
+await user.save()
+```
+
+### 3. Query Users
+
+```python
+users = await User.objects().filter(name="Alice").exec()
+for user in users:
+    print(user.name, user.email)
+```
+
+---
+
+## 🌟 Features
+
+- 🔧 **Model definition** using Pydantic  
+- 📄 **QuerySet** with filter methods like `filter()`, `limit()`, and `order_by()`  
+- 🔄 **CRUD** operations (Create, Read, Update, Delete)  
+- ⚙️ **Asynchronous connection** to SurrealDB  
+- 🔍 **Automatic validation** with Pydantic  
+- 📊 **Complex queries** with conditional filters (`age__gte`, `name__in`, etc.)  
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!  
+If you'd like to improve this project:
+
+1. Fork the repository.  
+2. Create a branch (`git checkout -b feature/new-feature`).  
+3. Make your changes and commit them (`git commit -m "Add new feature"`).  
+4. Push to your branch (`git push origin feature/new-feature`).  
+5. Create a Pull Request.  
+
+---
+
+## 📌 TODO
+
+- [ ] Implement relationships
+- [ ] Add transaction support  
+- [ ] Optimize complex queries  
+- [ ] Expand documentation with advanced examples  
+- [ ] Better SurrealQL Integration
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License**. See the `LICENSE` file for more information.
+
+---
+
+### 📨 Contact
+
+**Author:** Yannick Croteau  
+**Email:** <croteau.yannick@gmail.com>  
+**GitHub:** [EulogySnowfall](https://github.com/EulogySnowfall)  
+
+---
+
+**SurrealDB-ORM** is a personal package to use with other projects. I will certainly improve it over the next few months, but feel free to open issues or suggest improvements 🚀

surrealdb_orm-0.1.0/pyproject.toml

@@ -0,0 +1,93 @@
+[project]
+name = "surrealdb-orm"
+version = "0.1.0"
+description = "SurrealDB ORM as 'DJango style' for Python with async support. Works with pydantic validation."  
+readme = "README.md"
+requires-python = ">=3.11"
+license = {file = "LICENSE"}
+authors = [
+    { name = "Yannick Croteau", email = "yannick.croteau@gmail.com" }
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "pydantic>=2.10.4",
+    "surrealdb>=0.4.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/EulogySnowfall/SurrealDB-ORM"
+Documentation = "https://github.com/EulogySnowfall/SurrealDB-ORM"
+Repository = "https://github.com/EulogySnowfall/SurrealDB-ORM.git"
+Issues = "https://github.com/EulogySnowfall/SurrealDB-ORM/issues"
+
+[tool.setuptools]
+packages = ["src.surrealdb_orm"]
+
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 128
+target-version = "py311"
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+exclude = "^(tests|examples)/"
+
+[[tool.mypy.overrides]]
+module = ["surrealdb.*"]
+ignore_missing_imports = true
+no_implicit_reexport = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+addopts = "-ra -q --cov=src.surreal_orm --cov-branch --cov-report=xml --cov-report=html --cov-report=term-missing --cov-fail-under=70 --cov-context=test"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "module"
+# log_cli = true
+
+[tool.pyright]
+include = ["src"]
+
+[dependency-groups]
+dev = [
+    "ipykernel>=6.29.5",
+    "mypy>=1.14.0",
+    "pytest>=8.3.4",
+    "pytest-asyncio>=0.25.0",
+    "pytest-cov>=6.0.0",
+    "black>=24.10.0",
+    "pydantic>=2.10.4",
+    "docker>=7.1.0",
+    "isort>=5.13.2",
+    "flake8>=7.1.1",
+    "python-dotenv>=1.0.1",
+]
+lint = [
+    "ruff>=0.8.4",
+]
+
+
+[tool.hatch.build.targets.wheel]
+packages = ["src"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/README.md", "/Makefile", "/src", "/tests"]

surrealdb_orm-0.1.0/src/__init__.py

@@ -0,0 +1,3 @@
+from .surreal_orm import BaseSurrealModel, SurrealDBConnectionManager, QuerySet
+
+__all__ = ["BaseSurrealModel", "SurrealDBConnectionManager", "QuerySet"]

surrealdb_orm-0.1.0/src/surreal_orm/__init__.py

@@ -0,0 +1,6 @@
+from .model_base import BaseSurrealModel
+from .connection_manager import SurrealDBConnectionManager
+from .query_set import QuerySet
+from .enum import OrderBy
+
+__all__ = ["SurrealDBConnectionManager", "BaseSurrealModel", "QuerySet", "OrderBy"]