Metadata-Version: 2.1
Name: RogueORM
Version: 0.0.2
Summary: An ORM that strives to eradicate N+1 issues.
Author-email: Maxime Toussaint <m.toussaint@mail.com>
License: MIT License
        
        Copyright (c) 2022 Maxime Toussaint
        
        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.
        
Project-URL: Homepage, https://github.com/MaxDude132/RogueORM
Keywords: orm,database
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# RogueORM

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/MaxDude132/RogueORM/python-package.yml?branch=main)](https://github.com/MaxDude132/RogueORM/actions)
[![codecov](https://codecov.io/gh/MaxDude132/RogueORM/branch/main/graph/badge.svg?token=U7DKE4S8SV)](https://codecov.io/gh/MaxDude132/RogueORM)
[![GitHub](https://img.shields.io/github/license/MaxDude132/RogueORM)](https://github.com/MaxDude132/RogueORM/blob/main/LICENSE)

 A high level ORM that strives to get rid of all N+1 issues.

_Note_: This package is currently in development and is not production ready yet.

## Development Roadmap
 1. Define a clear syntax taking advantage of Python 3.10 and later's typing syntax. Status: Done
 2. Define models, managers and fields. Status: Done
 3. Add support for basic SQLite operation: SELECT, INSERT, UPDATE, DELETE. Status: Done
 4. Add support for Foreign Keys. Status: Done
 5. Add support for ManyToMany relationships using a joining table. Status: Done (Testing has to be improved)
 6. Add a migration system. Status: Started, PR #11
 7. Add support for relation lookup using a similar method to Django's, with __ being put between field names. Status: Not started
 8. Add support for JOIN, UNION and GROUP BY, with an interface to build them. Status: Not started
 9. Add logic for batch fetching in loops. Status: Not started
 10. Add logic for select_related. By design, prefetch_related will never be part of this ORM, preferring a 'fetch in batch when needed' approach. Status: Not started
 11. Look into supporting up to Python 3.7 by taking into account the possible usage of *Union* and *Optional* Maybe import from future? Status: Not started
 12. Improve testing by adding a way to catch queries made to the database, to make sure we lower them as much as possible. Status: Not started
 13. Add support for postgresql. Status: Not started
 14. Look into the next steps for the project. Status: Not started

If the project interests you, don't hesitate to reach out!
