Enhancement/blog example

.github/workflows/ci.yml

@@ -69,7 +69,7 @@ jobs:
     strategy:
       matrix:
         python-version: [ "3.10", "3.11", "3.12", "3.13" ]
-        example_app: ["todos"]
+        example_app: ["todos", "blog"]
 
     services:
       mongodb:

.gitignore

@@ -135,6 +135,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.venv3_13
 
 # Spyder project settings
 .spyderproject

CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Changed
+
+- Allowed `EmbeddedJsonModel`'s to also contain `EmbeddedJsonModel` if there is need.
+- Allowed extra key-word args to be passed to the `SQLModel()`
+- Made the defining of fields by calling `Field()` or `Relationship()` mandatory.
+  This is because SQLModel's require this, and fail if this is not the case.
+- Add support for "Many-to-One" relationships in SQL `insert()` implementation
+
+### Added
+
+- Added the [examples/blog](./examples/blog) example
+- Add the `link_model` parameter to the `SQLModel()` function to add link models used as through tables
+
 ## [0.1.6] - 2025-02-19
 
 ### Changed

CONTRIBUTING.md

@@ -77,7 +77,7 @@ By contributing, you agree that your contributions will be licensed under its MI
 - Install the dependencies
 
   ```bash
-  pip install -r requirements.txt
+  pip install -r ."[all,test]"
   ```
 
 - Run the pre-commit installation

LIMITATIONS.md

@@ -0,0 +1,15 @@
+# Limitations
+
+## Filtering
+
+### Redis
+
+- Mongo-style regular expression filtering is not supported. 
+  This is because native redis regular expression filtering is limited to the most basic text based search.
+
+## Update Operation
+
+### SQL 
+
+- Even though one can update a model to theoretically infinite number of levels deep,
+  the returned results can only contain 1-level-deep nested models and no more.

README.md

@@ -336,6 +336,11 @@ libraries = await redis_store.delete(
 
 - [ ] Add documentation site
 
+## Limitations
+
+This library is limited in some specific cases.
+Read through the [`LIMITATIONS.md`](./LIMITATIONS.md) file for more.
+
 ## Contributions
 
 Contributions are welcome. The docs have to maintained, the code has to be made cleaner, more idiomatic and faster,

examples/blog/.gitignore

@@ -0,0 +1,188 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# vscode
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# environments
+senv/
+renv/
+menv/
+
+# pyenv
+.python-version
+
+# sqlite test db
+test.db

examples/blog/LICENSE

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

examples/blog/README.md

@@ -0,0 +1,69 @@
+# Blog
+
+A simple Blog app based on [NQLStore](https://github.com/sopherapps/nqlstore)
+
+## Requirements
+
+- [Python +3.10](https://python.org)
+- [NQLStore](https://github.com/sopherapps/nqlstore)
+- [Redis stack (optional)](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/)
+- [MongoDB (optional)](https://www.mongodb.com/products/self-managed/community-edition)
+- [SQLite (optional)](https://www.sqlite.org/)
+
+## Getting Started
+
+- Ensure you have [Python +3.10](https://python.org) installed
+
+- Copy this repository and enter this folder
+
+```shell
+git clone https://github.com/sopherapps/nqlstore.git
+cd nqlstore/examples/blog
+```
+
+- Create a virtual env, activate it and install requirements
+
+```shell
+python -m venv env 
+source env/bin/activate
+pip install -r requirements.txt
+```
+
+- To use with [MongoDB](https://www.mongodb.com/try/download/community), install and start its server.
+- To use with redis, install [redis stack](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/) 
+  and start its server in another terminal.
+
+- Start the application, set the URL's for the database(s) to use.  
+  Options are:
+  - `SQL_URL` for [SQLite](https://www.sqlite.org/).
+  - `MONGO_URL` (required) and `MONGO_DB` (default: "todos") for [MongoDB](https://www.mongodb.com/products/self-managed/community-edition)
+  - `REDIS_URL` for [Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/).
+
+  _It is possible to use multiple databases at the same time. Just set multiple environment variables_
+
+```shell
+export SQL_URL="sqlite+aiosqlite:///test.db"
+#export MONGO_URL="mongodb://localhost:27017"
+#export MONGO_DB="testing"
+export REDIS_URL="redis://localhost:6379/0"
+fastapi dev main.py
+```
+
+## License
+
+Copyright (c) 2025 [Martin Ahindura](https://github.com/Tinitto)   
+Licensed under the [MIT License](./LICENSE)
+
+## Gratitude
+
+Glory be to God for His unmatchable love.
+
+> "As Jesus was on His way, the crowds almost crushed Him.
+> And a woman was there who had been subject to bleeding
+> for twelve years, but no one could heal her.
+> She came up behind Him and touched the edge of His cloak,
+> and immediately her bleeding stopped."
+>
+> -- Luke 8: 42-44
+
+<a href="https://www.buymeacoffee.com/martinahinJ" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>