| Name | RogueORM JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | An ORM that strives to eradicate N+1 issues. |
| upload_time | 2023-04-15 18:20:28 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| 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. |
| keywords |
orm
database
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RogueORM
[](https://github.com/MaxDude132/RogueORM/actions)
[](https://codecov.io/gh/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: Done (Testing has to be improved)
7. Add support for relation lookup using a similar method to Django's, with __ being put between field names. Status: Done
8. Add support for JOIN, UNION and GROUP BY, with an interface to build them. Status: Not started (Not a priority)
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!
Raw data
{
"_id": null,
"home_page": "",
"name": "RogueORM",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "orm,database",
"author": "",
"author_email": "Maxime Toussaint <m.toussaint@mail.com>",
"download_url": "https://files.pythonhosted.org/packages/ca/cb/aad8d176d2763729202da26170a6beba9f4f45792fbb6df78208b55dc1a7/RogueORM-0.1.0.tar.gz",
"platform": null,
"description": "# RogueORM\r\n\r\n[](https://github.com/MaxDude132/RogueORM/actions)\r\n[](https://codecov.io/gh/MaxDude132/RogueORM)\r\n[](https://github.com/MaxDude132/RogueORM/blob/main/LICENSE)\r\n\r\n A high level ORM that strives to get rid of all N+1 issues.\r\n\r\n_Note_: This package is currently in development and is not production ready yet.\r\n\r\n## Development Roadmap\r\n 1. Define a clear syntax taking advantage of Python 3.10 and later's typing syntax. Status: Done\r\n 2. Define models, managers and fields. Status: Done\r\n 3. Add support for basic SQLite operation: SELECT, INSERT, UPDATE, DELETE. Status: Done\r\n 4. Add support for Foreign Keys. Status: Done\r\n 5. Add support for ManyToMany relationships using a joining table. Status: Done (Testing has to be improved)\r\n 6. Add a migration system. Status: Done (Testing has to be improved)\r\n 7. Add support for relation lookup using a similar method to Django's, with __ being put between field names. Status: Done\r\n 8. Add support for JOIN, UNION and GROUP BY, with an interface to build them. Status: Not started (Not a priority)\r\n 9. Add logic for batch fetching in loops. Status: Not started\r\n 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\r\n 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\r\n 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\r\n 13. Add support for postgresql. Status: Not started\r\n 14. Look into the next steps for the project. Status: Not started\r\n\r\nIf the project interests you, don't hesitate to reach out!\r\n",
"bugtrack_url": null,
"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. ",
"summary": "An ORM that strives to eradicate N+1 issues.",
"version": "0.1.0",
"split_keywords": [
"orm",
"database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2425ca32d6c3d0f58501f93e4aa4d9e9db758df33a272ae177b6b65e4431234b",
"md5": "54ad945d3aa35740fafc82997b72142f",
"sha256": "23991f10ef6ce283c652712d430fafb77fbcde652141d14bc8348914da187136"
},
"downloads": -1,
"filename": "RogueORM-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54ad945d3aa35740fafc82997b72142f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 20865,
"upload_time": "2023-04-15T18:20:22",
"upload_time_iso_8601": "2023-04-15T18:20:22.889857Z",
"url": "https://files.pythonhosted.org/packages/24/25/ca32d6c3d0f58501f93e4aa4d9e9db758df33a272ae177b6b65e4431234b/RogueORM-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cacbaad8d176d2763729202da26170a6beba9f4f45792fbb6df78208b55dc1a7",
"md5": "1b633b800d8d0bc0201a8f2121c5ec1e",
"sha256": "f99d32efc6aa757e97b6cdc645ea34aefefcf9fb007b40b94d7367058c64aca8"
},
"downloads": -1,
"filename": "RogueORM-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1b633b800d8d0bc0201a8f2121c5ec1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15164,
"upload_time": "2023-04-15T18:20:28",
"upload_time_iso_8601": "2023-04-15T18:20:28.164815Z",
"url": "https://files.pythonhosted.org/packages/ca/cb/aad8d176d2763729202da26170a6beba9f4f45792fbb6df78208b55dc1a7/RogueORM-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-15 18:20:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "rogueorm"
}
