django-dynamic-query 0.1.0__tar.gz

django_dynamic_query-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.python-version
+uv.lock

django_dynamic_query-0.1.0/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 Liability. 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] [ُSajjad Cheriki]
+
+   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.

django_dynamic_query-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+recursive-include src/django_dynamic_query/templates *.html
+
+recursive-include src/django_dynamic_query/static *
+
+include README.md
+include LICENSE
+
+global-exclude __pycache__/*
+global-exclude *.py[cod]

django_dynamic_query-0.1.0/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: django-dynamic-query
+Version: 0.1.0
+Summary: A dynamic ORM query builder for Django with NLP support
+Author-email: sajjad-ch <sajjad.cheriki@gmail.com>
+License-File: LICENSE
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.14
+Requires-Dist: chromadb>=1.5.9
+Requires-Dist: django>=6.0.6
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: orjson>=3.11.9
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: pypika>=0.51.1
+Requires-Dist: requests>=2.34.2
+Provides-Extra: nlp
+Requires-Dist: huggingface-hub>=1.21.0; extra == 'nlp'
+Requires-Dist: openai>=1.63.0; extra == 'nlp'
+Requires-Dist: tokenizers>=0.23.1; extra == 'nlp'
+Description-Content-Type: text/markdown
+
+# Django Dynamic Query
+
+**Secure AI-powered Dynamic Django ORM Query Builder**
+
+`django-dynamic-query` is a Django package that allows developers to safely generate Django ORM queries from natural language using AI models such as **OpenAI** or **Ollama**.
+
+Instead of writing complex filtering logic manually, users can ask questions in plain English and the package converts them into validated Django ORM queries while protecting against unsafe operations.
+
+---
+
+## Features
+
+* AI-powered natural language querying
+* Secure ORM query generation
+* Schema indexing using Django management command
+* OpenAI support
+* Ollama support
+* Built-in validation layer
+* Protection against dangerous ORM operations
+* Easy Django integration
+* Simple web dashboard
+* Extensible architecture
+
+---
+
+# Installation
+
+Install using pip:
+
+```bash
+pip install django-dynamic-query
+```
+
+or
+
+```bash
+pip install git+https://github.com/sajjad-ch/django-dynamic-query.git
+```
+
+---
+
+# Requirements
+
+* Python 3.10+
+* Django 4.2+
+
+---
+
+# Add to INSTALLED_APPS
+
+Open your project's **settings.py**
+
+```python
+INSTALLED_APPS = [
+    ...
+    "django_dynamic_query",
+]
+```
+
+---
+Configuration
+Add the following configuration to your settings.py to enable and customize the AI-powered features:
+
+```python
+DJANGO_DYNAMIC_QUERY = {
+    # Set to True to enable AI processing (Natural Language to ORM)
+    "ENABLE_NLP": True,
+    
+    # Choose 'local' for Ollama/Local LLMs or 'api' for OpenAI/Cloud services
+    "MODEL_TYPE": "local", 
+    
+    # Required for 'local': The name of the model (e.g., 'gemma2', 'llama3')
+    "MODEL_NAME": "llama3",
+    
+    # Optional for 'local': Absolute path to a model file if not using a registry
+    "MODEL_PATH": None,
+    
+    # Required for 'api': Your API Key
+    "AI_API_KEY": "sk-...",
+}
+```
+---
+
+# Index Your Models
+
+Before using AI queries, index your Django models.
+
+Run:
+
+```bash
+python manage.py index_schema
+```
+
+This command scans your Django models and builds the schema used by the AI engine.
+
+Whenever your models change, run the command again.
+
+---
+
+# URLs
+
+Add the package URLs to your project.
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    ...
+    path(
+        "dynamic-query/",
+        include("django_dynamic_query.urls")
+    ),
+]
+```
+
+---
+
+# Dashboard
+
+After adding the URLs, open:
+
+```
+http://localhost:8000/dynamic-query/dashboard
+```
+
+The dashboard allows testing natural language queries directly from the browser.
+
+---
+
+# Basic Usage
+
+Example:
+
+```python
+from django_dynamic_query import ...
+
+# Your code here
+```
+
+Natural language example:
+
+```
+Show all active users created this month.
+```
+
+The package converts the request into a validated Django ORM query.
+
+---
+
+# Security
+
+The package is designed with security in mind.
+
+Validation includes:
+
+* Preventing dangerous ORM operations
+* Validating model names
+* Validating field names
+* Safe filter generation
+* Query sanitization
+
+---
+
+# Supported AI Providers
+
+Currently supported:
+
+* OpenAI
+* Ollama
+
+The architecture allows adding additional providers in the future.
+
+---
+
+# Project Structure
+
+```
+django_dynamic_query/
+
+├── core/
+│   ├── builder.py
+│   ├── validators.py
+│   └── exceptions.py
+│
+├── nlp/
+│   ├── ai_handler.py
+│   └── schema_rag.py
+│
+├── management/
+│   └── commands/
+│       └── index_schema.py
+│
+├── templates/
+│
+├── views.py
+├── urls.py
+└── utils.py
+```
+
+---
+
+# Running Tests
+
+Run all tests:
+
+```bash
+python -m pytest
+```
+
+or
+
+```bash
+python runtests.py
+```
+
+---
+
+# Development Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/sajjad-ch/django-dynamic-query.git
+```
+
+Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+---
+
+
+# Contributing
+
+Contributions are welcome.
+
+If you would like to improve the package:
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Open a Pull Request
+
+---
+
+# License
+
+This project is licensed under the MIT License.
+
+See the LICENSE file for details.
+
+---
+
+# Roadmap
+
+Future improvements include:
+
+* Additional AI providers
+* Better prompt optimization
+* Query explanation
+* Query caching
+* Admin integration
+* Multi-database support
+
+---
+
+# Author
+
+Developed with ❤️ for the Django community.