strapalchemy 0.1.0__tar.gz

strapalchemy-0.1.0/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(tree:*)"
+    ]
+  }
+}

strapalchemy-0.1.0/.gitignore

@@ -0,0 +1,178 @@
+# 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/
+.cursor
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+data
+.cursorrules
+
+# 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/
+.vscode
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

strapalchemy-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14.0

strapalchemy-0.1.0/LICENSE

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

strapalchemy-0.1.0/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: strapalchemy
+Version: 0.1.0
+Summary: Enhanced SQLAlchemy query builder with advanced filtering, sorting, pagination, and search capabilities.
+Project-URL: Homepage, https://github.com/faisalcayunda/strapalchemy
+Project-URL: Documentation, https://github.com/faisalcayunda/strapalchemy#readme
+Project-URL: Repository, https://github.com/faisalcayunda/strapalchemy
+Project-URL: Issues, https://github.com/faisalcayunda/strapalchemy/issues
+Author-email: Faisal Nugraha Cayunda <faisal.nugraha.c@gmail.com>
+Maintainer-email: Faisal Nugraha Cayunda <faisal.nugraha.c@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: database,filtering,orm,pagination,query-builder,search,sqlalchemy,strapi
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: greenlet>=3.3.0
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sqlalchemy>=2.0.45
+Provides-Extra: dev
+Requires-Dist: aiosqlite>=0.19.0; extra == 'dev'
+Requires-Dist: black>=24.0.0; extra == 'dev'
+Requires-Dist: greenlet>=3.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# StrapAlchemy
+
+> Enhanced SQLAlchemy query builder with advanced filtering, sorting, pagination, and search capabilities.
+
+StrapAlchemy is a powerful query builder library for SQLAlchemy that provides Strapi-style query syntax for building complex database queries with ease.
+
+## Features
+
+- **Advanced Filtering**: Strapi-style operators (`$eq`, `$in`, `$contains`, `$between`, etc.)
+- **Nested Relationship Filtering**: Filter through related models with dot notation
+- **Flexible Sorting**: Sort by direct fields or relationship fields
+- **Pagination**: Support for both page-based and offset-based pagination
+- **Full-Text Search**: BM25 search with ParadeDB integration and ILIKE fallback
+- **Field Selection**: Select specific fields to optimize query performance
+- **Relationship Population**: Eager load relationships to prevent N+1 queries
+- **Query Optimization**: Built-in caching and optimization for better performance
+- **Model Serialization**: Convert SQLAlchemy models to dictionaries easily
+
+## Installation
+
+```bash
+pip install strapalchemy
+```
+
+## Quick Start
+
+```python
+from sqlalchemy import select
+from strapalchemy import FilterBuilder, SortBuilder, Paginator, SearchEngine
+from strapalchemy.models import Base
+from sqlalchemy import Column, Integer, String
+
+# Define your model
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    email = Column(String)
+    status = Column(String)
+
+# Build your query
+query = select(User)
+
+# Apply filters
+filter_builder = FilterBuilder(User)
+query = await filter_builder.apply_filters(query, {
+    "name": {"$contains": "John"},
+    "status": {"$eq": "active"}
+})
+
+# Apply sorting
+sort_builder = SortBuilder(User)
+query = await sort_builder.apply_sorting(query, ["name:asc", "created_at:desc"])
+
+# Apply search
+search_engine = SearchEngine()
+query = await search_engine.apply_search(query, User, "search term")
+
+# Apply pagination
+paginator = Paginator(session, User)
+query, meta = await paginator.apply_pagination(query, {"page": 1, "page_size": 20})
+
+# Execute
+result = await session.execute(query)
+users = result.scalars().all()
+```
+
+## Filtering
+
+StrapAlchemy supports Strapi-style filtering operators:
+
+| Operator | Description | Example |
+|----------|-------------|---------|
+| `$eq` | Equal | `{"status": {"$eq": "active"}}` |
+| `$ne` | Not equal | `{"status": {"$ne": "deleted"}}` |
+| `$lt` | Less than | `{"age": {"$lt": 18}}` |
+| `$lte` | Less than or equal | `{"age": {"$lte": 18}}` |
+| `$gt` | Greater than | `{"age": {"$gt": 18}}` |
+| `$gte` | Greater than or equal | `{"age": {"$gte": 18}}` |
+| `$in` | In list | `{"status": {"$in": ["active", "pending"]}}` |
+| `$notIn` | Not in list | `{"status": {"$notIn": ["deleted"]}}` |
+| `$contains` | Contains | `{"name": {"$contains": "John"}}` |
+| `$containsi` | Contains (case insensitive) | `{"name": {"$containsi": "john"}}` |
+| `$startsWith` | Starts with | `{"email": {"$startsWith": "admin"}}` |
+| `$endsWith` | Ends with | `{"email": {"$endsWith": "@example.com"}}` |
+| `$null` | Is null | `{"deleted_at": {"$null": true}}` |
+| `$notNull` | Is not null | `{"email": {"$notNull": true}}` |
+| `$between` | Between | `{"created_at": {"$between": ["2024-01-01", "2024-12-31"]}}` |
+| `$or` | Logical OR | `{"$or": [{"status": {"$eq": "active"}}, {"status": {"$eq": "pending"}}]}` |
+| `$and` | Logical AND | `{"$and": [{"status": {"$eq": "active"}}, {"verified": {"$eq": true}}]}` |
+
+### Nested Relationship Filtering
+
+```python
+# Filter by relationship fields
+query = await filter_builder.apply_filters(query, {
+    "organization": {"slug": {"$eq": "acme"}}
+})
+
+# Or use dot notation
+query = await filter_builder.apply_filters(query, {
+    "organization.slug": {"$eq": "acme"}
+})
+```
+
+## Sorting
+
+```python
+# Sort by single field
+query = await sort_builder.apply_sorting(query, "name:asc")
+
+# Sort by multiple fields
+query = await sort_builder.apply_sorting(query, ["name:asc", "created_at:desc"])
+
+# Sort by relationship field
+query = await sort_builder.apply_sorting(query, ["organization.name:asc"])
+```
+
+## Pagination
+
+### Page-based Pagination
+
+```python
+query, meta = await paginator.apply_pagination(query, {
+    "page": 1,
+    "page_size": 20
+})
+
+# meta contains:
+# {
+#     "page": 1,
+#     "page_size": 20,
+#     "page_count": 5,
+#     "total": 100,
+#     "has_next": True,
+#     "has_previous": False
+# }
+```
+
+### Offset-based Pagination
+
+```python
+query, meta = await paginator.apply_pagination(query, {
+    "start": 0,
+    "limit": 20
+})
+```
+
+## Field Selection
+
+```python
+from strapalchemy import FieldSelector
+
+field_selector = FieldSelector(User)
+query = await field_selector.apply_field_selection(query, ["id", "name", "email"])
+
+# Select relationship fields
+query = await field_selector.apply_field_selection(query, ["id", "name", "organization.slug"])
+```
+
+## Model Serialization
+
+```python
+from strapalchemy import ModelSerializer
+
+# Serialize a single model
+data = ModelSerializer.serialize(user, fields=["id", "name", "email"])
+
+# Serialize a list
+data = ModelSerializer.serialize(users, fields=["id", "name"])
+
+# Serialize with relationships
+data = ModelSerializer.serialize(user, populate="organization")
+
+# Serialize with nested relationships
+data = ModelSerializer.serialize(user, populate=["organization", "user.role"])
+```
+
+## Search
+
+```python
+from strapalchemy import SearchEngine
+
+search_engine = SearchEngine()
+
+# Add searchable fields to your model
+class User(Base):
+    __tablename__ = "users"
+    __searchable__ = {
+        "text_fields": ["name", "email", "bio"]
+    }
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    email = Column(String)
+    bio = Column(String)
+
+# Apply search
+query = await search_engine.apply_search(query, User, "John Doe")
+```
+
+## Advanced Usage
+
+### Combining Multiple Builders
+
+```python
+async def get_users(filters=None, sort=None, search=None, page=None):
+    query = select(User)
+
+    if filters:
+        query = await filter_builder.apply_filters(query, filters)
+
+    if sort:
+        query = await sort_builder.apply_sorting(query, sort)
+
+    if search:
+        query = await search_engine.apply_search(query, User, search)
+
+    if page:
+        query, meta = await paginator.apply_pagination(query, page)
+
+    result = await session.execute(query)
+    return result.scalars().all(), meta
+```
+
+## Requirements
+
+- Python >= 3.12
+- SQLAlchemy >= 2.0.45
+- python-dateutil >= 2.9.0
+- rich >= 13.0.0
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Support
+
+For issues and questions, please use the GitHub issue tracker.