AxiomQuery 0.1.0__tar.gz

axiomquery-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,64 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          python -m pip install build hatchling
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      url: https://pypi.org/p/AxiomQuery
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

axiomquery-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

axiomquery-0.1.0/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to `AxiomQuery` are documented here.
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.1.0] — 2026-03-29
+
+Initial release.
+
+### Added
+
+- `QueryEngine` — specification-based query facade for any SQLAlchemy 2.0 ORM model
+- `list()` / `alist()` — filtered record retrieval with `limit`, `offset`, `order_by`
+- `read_group()` / `aread_group()` — grouped aggregation (GROUP BY + HAVING) with `__domain` drill-down per group
+- Domain filter DSL — composable JSON expressions: `[field, op, value]`, `{"and": [...]}`, `{"or": [...]}`, `{"not": ...}`
+- Full operator set: `=` `!=` `>` `<` `>=` `<=` `in` `not in` `like` `ilike` `is_null`
+- Child field filtering via EXISTS subquery (dot notation: `"lines.quantity"`)
+- Child field aggregation via LEFT JOIN (`"lines.quantity:sum"`)
+- Date granularity grouping: `day` `week` `month` `quarter` `year`
+- Aggregate functions: `count` `sum` `avg` `min` `max`
+- HAVING filter on aggregate aliases
+- Schema auto-derived from `inspect(model_class)` — O2M relationships are children by convention
+- Sync (`Session`) and async (`AsyncSession`) APIs
+- `QueryError` with `code` and `message` — field validation at compile time, before DB
+- `py.typed` marker — PEP 561 inline type annotations

axiomquery-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to AxiomQuery
+
+## Setup
+
+Requires Python 3.12+ and [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/Axiom-Dev-Labs/AxiomQuery
+cd AxiomQuery
+uv sync
+```
+
+## Running tests
+
+```bash
+uv run pytest
+```
+
+The test suite uses SQLite in-memory — no external DB needed.
+
+## Project layout
+
+```
+src/axiom_query/
+  errors.py             QueryError
+  operators.py          Op enum
+  ast.py                Immutable AST nodes (Condition, And, Or, Not, Bool)
+  parser.py             parse_domain() — JSON → AST
+  schema.py             derive_schema() — ModelSchema from SA inspect()
+  compiler.py           compile_domain() → SA WHERE ColumnElement
+  aggregation.py        ReadGroupQuery AST nodes
+  aggregation_parser.py parse_read_group() — raw dict → ReadGroupQuery
+  compiler_aggregate.py compile_read_group() → SA SELECT
+  engine.py             QueryEngine — public facade
+tests/
+  conftest.py           Order/OrderLine fixtures, SQLite engine
+  test_list.py          list() / alist() tests
+  test_read_group.py    read_group() tests
+  test_async.py         async tests
+examples/
+  example_sync.py       Runnable sync walkthrough
+  example_async.py      Runnable async walkthrough
+```
+
+## Adding a new operator
+
+1. Add the value to `Op` in `operators.py`
+2. Handle it in `_apply_operator()` in `compiler.py`
+3. Handle it in `_apply_having_operator()` if valid in HAVING context
+4. Add a test in `test_list.py`
+
+## Adding a new aggregate function
+
+1. Add the value to `AggFunc` in `aggregation.py`
+2. Handle it in `_compile_aggregate_column()` in `compiler_aggregate.py`
+3. Add a test in `test_read_group.py`
+
+## Release checklist
+
+- [ ] Bump `version` in `pyproject.toml` and `__init__.py`
+- [ ] Add entry to `CHANGELOG.md`
+- [ ] Run full test suite: `uv run pytest`
+- [ ] Build: `uv build`
+- [ ] Publish: `uv publish`

axiomquery-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Axiom Contributors
+
+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.

axiomquery-0.1.0/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: AxiomQuery
+Version: 0.1.0
+Summary: Specification-based query and aggregation engine for SQLAlchemy 2.0 ORM models
+Project-URL: Source Code, https://github.com/Axiom-Dev-Labs/AxiomQuery
+Project-URL: Bug Tracker, https://github.com/Axiom-Dev-Labs/AxiomQuery/issues
+Project-URL: Changelog, https://github.com/Axiom-Dev-Labs/AxiomQuery/blob/main/CHANGELOG.md
+Author: Axiom Contributors
+License: MIT License
+        
+        Copyright (c) 2026 Axiom Contributors
+        
+        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.
+License-File: LICENSE
+Keywords: domain,filter,groupby,orm,query,specification,sqlalchemy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: sqlalchemy>=2.0
+Description-Content-Type: text/markdown
+
+# AxiomQuery
+
+Specification-based query and aggregation engine for SQLAlchemy 2.0 ORM models.
+
+Define filters as composable data — JSON lists, dicts, or Python AST nodes — and execute them against any ORM model without writing raw SQL.
+
+---
+
+## Install
+
+```bash
+pip install AxiomQuery
+```
+
+Requires Python 3.12+ and SQLAlchemy 2.0+.
+
+---
+
+## Quick start
+
+```python
+from axiom_query import QueryEngine
+
+engine = QueryEngine(Order)   # inspect() once — no DB connection at construction
+
+with Session(db) as session:
+    # list
+    records = engine.list(session, domain=[["status", "=", "CONFIRMED"]])
+
+    # read_group
+    groups, total = engine.read_group(
+        session,
+        groupby=["status"],
+        aggregates=["__count", "total:sum"],
+    )
+```
+
+---
+
+## Domain filter syntax
+
+A **domain** is a JSON-serialisable expression compiled to a WHERE clause at query time.
+
+### Condition tuple
+
+```python
+[field_path, operator, value]
+```
+
+| Operator | Meaning |
+|----------|---------|
+| `=` `!=` `>` `<` `>=` `<=` | Comparison |
+| `in` `not in` | Membership (value is a list) |
+| `like` `ilike` | Pattern match (`%` wildcard) |
+| `is_null` | Null check (value is `True`/`False`) |
+
+### Logical composition
+
+```python
+# AND — list of conditions (implicit)
+[["status", "=", "CONFIRMED"], ["total", ">", 100]]
+
+# AND — explicit
+{"and": [["status", "=", "CONFIRMED"], ["total", ">", 100]]}
+
+# OR
+{"or": [["status", "=", "DRAFT"], ["status", "=", "CANCELLED"]]}
+
+# NOT
+{"not": ["status", "=", "CANCELLED"]}
+
+# Combined — list mixes plain conditions with logical dicts
+[
+    {"or": [["status", "=", "CONFIRMED"], ["status", "=", "DRAFT"]]},
+    {"not": ["total", "=", 0]},
+]
+```
+
+### Child field (EXISTS subquery)
+
+Filter parent records by a child relationship field using dot notation. O2M relationships are automatically detected via `inspect()`.
+
+```python
+# Orders that have at least one line with quantity > 2
+engine.list(session, domain=[["lines.quantity", ">", 2]])
+```
+
+---
+
+## `list()` — filtered records
+
+```python
+records = engine.list(
+    session,
+    domain=None,          # domain expression or None (all records)
+    limit=None,           # max records to return
+    offset=None,          # records to skip
+    order_by=None,        # [["field", "asc|desc"], ...]
+)
+# returns list[ORM model instances]
+```
+
+---
+
+## `read_group()` — grouped aggregation
+
+```python
+groups, total = engine.read_group(
+    session,
+    groupby=["status", "created_at:month"],   # field or field:granularity
+    aggregates=["__count", "total:sum"],       # __count or field:func
+    domain=None,                              # WHERE filter
+    having=None,                              # HAVING filter on aggregate aliases
+    order_by=None,                            # [["alias", "asc|desc"], ...]
+    limit=None,
+    offset=None,
+)
+# returns (list[dict], int)  — each dict includes a __domain key
+```
+
+**Aggregate functions:** `count` `sum` `avg` `min` `max`
+
+**Date granularities:** `day` `week` `month` `quarter` `year`
+
+**Child aggregate** (LEFT JOIN):
+
+```python
+engine.read_group(session, groupby=["status"], aggregates=["lines.quantity:sum"])
+```
+
+**`__domain` drill-down** — each group result includes a `__domain` ready to pass back to `list()`:
+
+```python
+groups, _ = engine.read_group(session, groupby=["status"], aggregates=["__count"])
+for group in groups:
+    records = engine.list(session, domain=group["__domain"])
+```
+
+---
+
+## Async API
+
+Prefix any method with `a` and pass an `AsyncSession`:
+
+```python
+engine = QueryEngine(Order)
+
+async with AsyncSession(db) as session:
+    records = await engine.alist(session, domain=[["status", "=", "CONFIRMED"]])
+    groups, total = await engine.aread_group(session, groupby=["status"], aggregates=["__count"])
+```
+
+---
+
+## Schema derivation
+
+`QueryEngine` derives its schema from `inspect(model_class)` at construction time — no separate descriptor needed:
+
+- **Columns** → from `mapper.columns`
+- **Child relations** → O2M relationships (`RelationshipDirection.ONETOMANY`) become filterable child entities
+- **FK column** → resolved from `rel.synchronize_pairs`
+
+---
+
+## Error handling
+
+Invalid field paths and unsupported operators raise `QueryError` before hitting the database:
+
+```python
+from axiom_query import QueryError
+
+try:
+    engine.list(session, domain=[["unknown_field", "=", "x"]])
+except QueryError as e:
+    print(e.code, e.message)   # INVALID_FILTER_FIELD  No field 'unknown_field' ...
+```
+
+---
+
+## Examples
+
+Self-contained runnable examples in [`examples/`](examples/):
+
+```bash
+python examples/example_sync.py
+python examples/example_async.py
+```
+
+Both cover: simple filters, AND / OR / NOT, combined nesting, child EXISTS filtering, pagination, `read_group` with domain / date granularity / child aggregation / HAVING, and `__domain` drill-down.