lightodm 0.1.0__py3-none-any.whl

lightodm-0.1.0.dist-info/METADATA

@@ -0,0 +1,346 @@
+Metadata-Version: 2.4
+Name: lightodm
+Version: 0.1.0
+Summary: Lightweight MongoDB ODM - Simple async/sync Object-Document Mapper for MongoDB
+Project-URL: Homepage, https://github.com/Aprova-GmbH/lightodm
+Project-URL: Repository, https://github.com/Aprova-GmbH/lightodm
+Project-URL: Documentation, https://github.com/Aprova-GmbH/lightodm#readme
+Project-URL: Issues, https://github.com/Aprova-GmbH/lightodm/issues
+Author-email: Andrey Vykhodtsev <vya@aprova.ch>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: async,database,mongodb,motor,odm,orm,pydantic,pymongo
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: motor>=3.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pymongo>=4.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0; extra == 'dev'
+Requires-Dist: mongomock>=4.0; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'dev'
+Requires-Dist: sphinx>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# LightODM
+
+[![PyPI version](https://badge.fury.io/py/lightodm.svg)](https://badge.fury.io/py/lightodm)
+[![Python versions](https://img.shields.io/pypi/pyversions/lightodm.svg)](https://pypi.org/project/lightodm/)
+[![Build Status](https://github.com/Aprova-GmbH/lightodm/workflows/Tests/badge.svg)](https://github.com/Aprova-GmbH/lightodm/actions)
+[![Coverage](https://codecov.io/gh/Aprova-GmbH/lightodm/branch/main/graph/badge.svg)](https://codecov.io/gh/Aprova-GmbH/lightodm)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+**Lightweight MongoDB ODM** - A simple, fast Object-Document Mapper for MongoDB with full async/sync support.
+
+LightODM is a minimal alternative to [Beanie](https://github.com/roman-right/beanie) that provides essential ODM functionality without the complexity. Built on Pydantic v2, PyMongo, and Motor.
+
+## Features
+
+- **Dual Mode**: Full support for both sync (PyMongo) and async (Motor) operations
+- **Lightweight**: Zero dependencies beyond Pydantic, PyMongo, and Motor
+- **Type Safe**: Full type hints with py.typed marker
+- **Pydantic v2**: Built on Pydantic v2 for robust validation
+- **Simple API**: Clean, intuitive interface similar to Beanie
+- **Flexible**: Optional connection - override `get_collection()` for custom setups
+- **Thread Safe**: Singleton connection manager with automatic cleanup
+
+## Installation
+
+```bash
+pip install lightodm
+```
+
+## Quick Start
+
+### Define Your Models
+
+```python
+from lightodm import MongoBaseModel
+from typing import Optional
+
+class User(MongoBaseModel):
+    class Settings:
+        name = "users"  # MongoDB collection name
+
+    name: str
+    email: str
+    age: Optional[int] = None
+```
+
+### Environment Setup
+
+Set your MongoDB connection via environment variables:
+
+```bash
+export MONGO_URL="mongodb://localhost:27017"
+export MONGO_USER="your_user"
+export MONGO_PASSWORD="your_password"
+export MONGO_DB_NAME="your_database"
+```
+
+### Sync Usage
+
+```python
+# Create and save
+user = User(name="John Doe", email="john@example.com", age=30)
+user.save()
+
+# Retrieve by ID
+user = User.get("some_id")
+
+# Find documents
+users = User.find({"age": {"$gte": 18}})
+adult_user = User.find_one({"age": {"$gte": 18}})
+
+# Update
+User.update_one({"name": "John Doe"}, {"$set": {"age": 31}})
+
+# Delete
+user.delete()
+User.delete_many({"age": {"$lt": 18}})
+
+# Count
+count = User.count({"age": {"$gte": 18}})
+
+# Aggregation
+pipeline = [{"$group": {"_id": "$age", "count": {"$sum": 1}}}]
+results = User.aggregate(pipeline)
+```
+
+### Async Usage
+
+```python
+# Create and save
+user = User(name="Jane Doe", email="jane@example.com", age=25)
+await user.asave()
+
+# Retrieve by ID
+user = await User.aget("some_id")
+
+# Find documents
+users = await User.afind({"age": {"$gte": 18}})
+adult_user = await User.afind_one({"age": {"$gte": 18}})
+
+# Iterate over large result sets
+async for user in User.afind_iter({"age": {"$gte": 18}}):
+    print(user.name)
+
+# Update
+await User.aupdate_one({"name": "Jane Doe"}, {"$set": {"age": 26}})
+
+# Delete
+await user.adelete()
+await User.adelete_many({"age": {"$lt": 18}})
+
+# Count
+count = await User.acount({"age": {"$gte": 18}})
+
+# Aggregation
+pipeline = [{"$group": {"_id": "$age", "count": {"$sum": 1}}}]
+results = await User.aaggregate(pipeline)
+```
+
+## Advanced Usage
+
+### Custom ID Generation
+
+```python
+from lightodm import MongoBaseModel, generate_id
+
+class Product(MongoBaseModel):
+    class Settings:
+        name = "products"
+
+    # Custom ID (default uses ObjectId)
+    id: str = None
+
+    name: str
+    sku: str
+
+# Default uses ObjectId
+product = Product(name="Widget", sku="WDG-001")
+print(product.id)  # Generated ObjectId string
+```
+
+### Custom Connection
+
+Override `get_collection()` or `get_async_collection()` for custom connection logic:
+
+```python
+class CustomUser(MongoBaseModel):
+    class Settings:
+        name = "custom_users"
+
+    name: str
+
+    @classmethod
+    def get_collection(cls):
+        # Your custom connection logic
+        from pymongo import MongoClient
+        client = MongoClient("mongodb://custom-host:27017")
+        return client["custom_db"]["custom_users"]
+```
+
+### Extra Fields
+
+LightODM supports Pydantic's `extra='allow'` for dynamic fields:
+
+```python
+user = User(name="John", email="john@example.com", custom_field="value")
+user.save()  # custom_field is preserved in MongoDB
+```
+
+### Bulk Operations
+
+```python
+# Sync
+users = [
+    User(name="User 1", email="user1@example.com"),
+    User(name="User 2", email="user2@example.com"),
+]
+ids = User.insert_many(users)
+
+# Async
+ids = await User.ainsert_many(users)
+```
+
+## LightODM vs Beanie
+
+| Feature | LightODM | Beanie |
+|---------|----------|--------|
+| **Dependencies** | Pydantic, PyMongo, Motor | Pydantic, PyMongo, Motor, lazy-model, toml |
+| **Initialization** | Environment variables | `init_beanie()` required |
+| **Sync Support** | ✅ Full | ❌ Async only |
+| **Async Support** | ✅ Full | ✅ Full |
+| **Connection** | Optional singleton | Required initialization |
+| **Learning Curve** | Low | Medium |
+| **Code Size** | ~500 lines | ~5000+ lines |
+| **Use Case** | Simple projects, microservices | Complex applications |
+| **Relations** | Manual (MongoDB refs) | Built-in with Link |
+| **Migrations** | Manual | Manual |
+| **Indexes** | Manual | Automatic |
+| **Validation** | Pydantic v2 | Pydantic v2 |
+| **Type Safety** | ✅ Full | ✅ Full |
+
+**Choose LightODM if:**
+- You want a simple, lightweight ODM
+- You need both sync and async support
+- You prefer minimal dependencies
+- You want control over connection management
+- You're building microservices or simple applications
+
+**Choose Beanie if:**
+- You need built-in relations and document links
+- You want automatic index management
+- You prefer async-first design
+- You're building complex applications with many models
+
+## API Reference
+
+### MongoBaseModel
+
+Base class for MongoDB document models.
+
+#### Sync Methods
+
+- `save(exclude_none=False) -> str` - Save/upsert document
+- `delete() -> bool` - Delete document
+- `get(id) -> Optional[T]` - Get by ID
+- `find_one(filter, **kwargs) -> Optional[T]` - Find single document
+- `find(filter, **kwargs) -> List[T]` - Find multiple documents
+- `find_iter(filter, **kwargs) -> Iterator[T]` - Iterate over results
+- `count(filter=None) -> int` - Count documents
+- `update_one(filter, update, upsert=False) -> bool` - Update single document
+- `update_many(filter, update) -> int` - Update multiple documents
+- `delete_one(filter) -> bool` - Delete single document
+- `delete_many(filter) -> int` - Delete multiple documents
+- `aggregate(pipeline, **kwargs) -> List[dict]` - Run aggregation pipeline
+- `insert_many(documents) -> List[str]` - Insert multiple documents
+
+#### Async Methods
+
+All sync methods have async equivalents prefixed with `a`:
+
+- `asave()`, `adelete()`, `aget()`, `afind_one()`, `afind()`, `afind_iter()`, `acount()`,
+- `aupdate_one()`, `aupdate_many()`, `adelete_one()`, `adelete_many()`,
+- `aaggregate()`, `ainsert_many()`
+
+### Connection Functions
+
+```python
+from lightodm import (
+    get_mongo_connection,
+    get_collection,
+    get_database,
+    get_client,
+    get_async_database,
+    get_async_client,
+)
+
+# Get singleton connection
+conn = get_mongo_connection()
+
+# Sync helpers
+collection = get_collection("users")
+db = get_database()
+client = get_client()
+
+# Async helpers
+db = await get_async_database()
+client = await get_async_client()
+```
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/Aprova-GmbH/lightodm.git
+cd lightodm
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src tests
+ruff check src tests --fix
+
+# Type checking
+mypy src
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+Apache License 2.0 - see [LICENSE](LICENSE) file for details.
+
+## Author
+
+**Andrey Vykhodtsev** - [vya@aprova.ch](mailto:vya@aprova.ch)
+
+## Links
+
+- **Repository**: https://github.com/Aprova-GmbH/lightodm
+- **Issues**: https://github.com/Aprova-GmbH/lightodm/issues

lightodm-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+lightodm/__init__.py,sha256=HWLNWbrsx_hzn2Vx8qi3gaQWLK6mRn0GaQ_SLc5KdtI,1082
+lightodm/connection.py,sha256=6iNaSVO9BVA6Y8XoOoULBw7i__h4L3WBjnJKGLjpR9s,9888
+lightodm/model.py,sha256=po98-T2OQQTIwVxVi7PsG4j8FOGzqwzMisKLDW1OmJA,19103
+lightodm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lightodm-0.1.0.dist-info/METADATA,sha256=4snZ6jkissXHIFJElPJxG_TCIN9yF7RvDoRE-Wx8BNc,9921
+lightodm-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+lightodm-0.1.0.dist-info/licenses/LICENSE,sha256=fL7HOAbNeitdXBSp3bN-4VK6kH26E8ScX3vv5qSsAQI,11345
+lightodm-0.1.0.dist-info/RECORD,,

lightodm-0.1.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

lightodm-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Support. 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Andrey Vykhodtsev
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.