surrealdb-orm 0.1.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

surrealdb_orm-0.1.3.dist-info/METADATA

@@ -1,184 +0,0 @@
-Metadata-Version: 2.4
-Name: surrealdb-orm
-Version: 0.1.3
-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)
-
----
-
-## ✅ Version
-
-Alpha 0.1.3
-
----
-
-## 📝 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.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-surreal_orm/__init__.py,sha256=RNoDt0Gt7_jTjzxzXGPXKUqe7EnCdt31b35tnA-JcOM,243
-surreal_orm/connection_manager.py,sha256=kRAK6qhkKRVbhTjWZV6LaOGiH_jClwQ3zzmjca1A5Ro,8561
-surreal_orm/constants.py,sha256=CLavEca1M6cLJLqVl4l4KoE-cBrgVQNsuGxW9zGJBmg,429
-surreal_orm/enum.py,sha256=kR-vzkHqnqy9YaYOvWTwAHdl2-WCzPcSEch-YTyJv1Y,158
-surreal_orm/model_base.py,sha256=U9ZJeOS75uJXMvhKTNy8I2QDXMxoF5eVUkQe-vesggk,7358
-surreal_orm/query_set.py,sha256=ng-jTFWiUpxPJH-KC7SNxZ2PwmciCnkOifOWa7A2KEs,18156
-surreal_orm/utils.py,sha256=mni_dTtb4VGTdge8eWSZpBw5xoWci2m-XThKFHYPKTo,171
-surrealdb_orm-0.1.3.dist-info/METADATA,sha256=T9tXMFp3th-r4FMnFQt2s8z4Pz5zCs0_KoE33k64-gU,5980
-surrealdb_orm-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-surrealdb_orm-0.1.3.dist-info/licenses/LICENSE,sha256=TO3Ub0nPPx5NxwjsDuBAu3RBdBLmdDybqC5dem4oGts,1074
-surrealdb_orm-0.1.3.dist-info/RECORD,,