sqlo 0.0.1__tar.gz

sqlo-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+Please provide a code snippet that reproduces the issue:
+
+```python
+from sqlo import Q
+
+# Your code here
+query = Q.select("...")...
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. macOS, Windows, Linux]
+ - Python Version [e.g. 3.11]
+ - sqlo Version [e.g. 0.0.1]
+
+**Additional context**
+Add any other context about the problem here.

sqlo-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

sqlo-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
+
+Fixes # (issue)
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

sqlo-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run ruff format check
+        run: uv run ruff format --check .
+
+      - name: Run ruff linter
+        run: uv run ruff check .
+
+      - name: Run mypy
+        run: uv run mypy src/
+
+      - name: Run complexity check
+        run: uv run xenon --max-absolute C --max-modules C --max-average B src
+
+      - name: Run security check
+        run: uv run bandit -c pyproject.toml -r src
+
+      - name: Run tests
+        run: uv run pytest --cov=sqlo --cov-report=xml --cov-report=term
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.11'
+        with:
+          file: ./coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false

sqlo-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: uv publish

sqlo-0.0.1/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Env
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Testing
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+reports/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# MacOS
+.DS_Store

sqlo-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      # Run the formatter
+      - id: ruff-format
+        types_or: [python, pyi]
+      # Run the linter
+      - id: ruff
+        types_or: [python, pyi]
+        args: [--fix]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        additional_dependencies: []
+        args: [--ignore-missing-imports]

sqlo-0.0.1/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2025-11-28
+
+### Added
+- Initial release of `sqlo`.
+- Support for SELECT, INSERT, UPDATE, DELETE queries.
+- MySQL dialect support.
+- Type-safe query building API.
+- Comprehensive test coverage (99%).
+- Code quality tools: ruff, mypy, xenon, bandit.

sqlo-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing to sqlo
+
+Thank you for your interest in contributing to `sqlo`!
+
+For detailed instructions on setting up your development environment, running tests, and code style guidelines, please refer to our [Development Guide](DEVELOPMENT.md).
+
+## Pull Requests
+
+1. Fork the repository.
+2. Create a new branch for your feature or fix.
+3. Make your changes and add tests.
+4. Ensure all tests pass and code is formatted correctly (see [Development Guide](DEVELOPMENT.md)).
+5. Submit a Pull Request.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

sqlo-0.0.1/DEVELOPMENT.md

@@ -0,0 +1,76 @@
+# Development Workflow
+
+## Using uv (Recommended)
+
+uv doesn't require scripts configuration. Just use `uv run` directly:
+
+```bash
+# Run tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=sqlo --cov-report=html
+
+# Format code
+uv run ruff format .
+
+# Lint code
+uv run ruff check .
+
+# Auto-fix linting issues
+uv run ruff check --fix .
+
+# Type check
+uv run mypy src/
+
+# Install dependencies
+uv sync --all-extras
+```
+
+## Using Makefile (Simpler)
+
+We've created a Makefile for convenience:
+
+```bash
+# Run tests
+make test
+
+# Run tests with coverage
+make coverage
+
+# Format code
+make format
+
+# Lint code
+make lint
+
+# Auto-fix linting issues
+make lint-fix
+
+# Type check
+make typecheck
+
+# Run all checks (format + lint + typecheck)
+make check
+
+# Install pre-commit hooks
+make pre-commit-install
+
+# Clean build artifacts
+make clean
+```
+
+## Recommendation
+
+- **For quick commands**: Use `uv run <command>`
+- **For complex workflows**: Use `make <target>`
+- **For CI/CD**: Use `uv run` directly
+
+Example CI/CD workflow:
+```yaml
+- run: uv sync --all-extras
+- run: uv run ruff format --check .
+- run: uv run ruff check .
+- run: uv run mypy src/
+- run: uv run pytest --cov=sqlo
+```

sqlo-0.0.1/LICENSE

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

sqlo-0.0.1/Makefile

@@ -0,0 +1,64 @@
+.PHONY: install format lint check test coverage clean
+
+# Install dependencies
+install:
+	uv sync --all-extras
+
+# Format code (imports and sources)
+format:
+	uv run ruff check --select I --fix .
+	uv run ruff format .
+
+# Check code style (format, lint, types)
+style:
+	uv run ruff format --check .
+	uv run ruff check .
+	uv run mypy src/
+
+# Check code complexity
+complexity:
+	uv run xenon --max-absolute C --max-modules C --max-average B src
+
+# Check security issues
+security:
+	uv run bandit -c pyproject.toml -r src
+
+# Run all checks (alias for style)
+check: style
+
+# Run tests
+test:
+	uv run pytest --cov=sqlo --cov-report=term-missing
+
+# Run tests with coverage
+coverage:
+	uv run pytest --cov=sqlo --cov-report=html --cov-report=term-missing
+
+# Test against multiple Python versions (requires pyenv or similar)
+test-all-versions:
+	@echo "Testing Python 3.9..."
+	@uv run --python 3.9 pytest || echo "Python 3.9 not available"
+	@echo "Testing Python 3.10..."
+	@uv run --python 3.10 pytest || echo "Python 3.10 not available"
+	@echo "Testing Python 3.11..."
+	@uv run --python 3.11 pytest || echo "Python 3.11 not available"
+	@echo "Testing Python 3.12..."
+	@uv run --python 3.12 pytest || echo "Python 3.12 not available"
+	@echo "Testing Python 3.13..."
+	@uv run --python 3.13 pytest || echo "Python 3.13 not available"
+	@echo "Testing Python 3.14..."
+	@uv run --python 3.14 pytest || echo "Python 3.14 not available"
+
+# Install pre-commit hooks
+pre-commit-install:
+	uv run pre-commit install
+
+# Run pre-commit on all files
+pre-commit-run:
+	uv run pre-commit run --all-files
+
+# Clean build artifacts
+clean:
+	rm -rf build/ dist/ *.egg-info .pytest_cache .ruff_cache .mypy_cache htmlcov/
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name '*.pyc' -delete

sqlo-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: sqlo
+Version: 0.0.1
+Summary: A modern, type-safe, and extensible SQL query builder for Python.
+Project-URL: Homepage, https://github.com/nan-guo/sqlo
+Project-URL: Repository, https://github.com/nan-guo/sqlo
+License: MIT
+License-File: LICENSE
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+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
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=3.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.1.2; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: xenon>=0.9.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sqlo
+
+[![CI](https://github.com/nan-guo/sqlo/actions/workflows/ci.yml/badge.svg)](https://github.com/nan-guo/sqlo/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/sqlo)](https://pypi.org/project/sqlo/)
+[![License](https://img.shields.io/github/license/nan-guo/sqlo)](LICENSE)
+
+
+**sqlo** is a modern, type-safe, and extensible SQL query builder for Python. It allows you to construct complex SQL queries using a fluent, Pythonic API while ensuring safety against SQL injection.
+
+## Features
+
+- 🛡️ **Safe**: Automatic parameter binding prevents SQL injection.
+- 🐍 **Pythonic**: Fluent API design that feels natural to Python developers.
+- 🧩 **Composable**: Build complex queries from reusable parts.
+- 🚀 **Extensible**: Support for custom dialects and functions.
+- 🔍 **Type-Safe**: Designed with type hints for better IDE support.
+
+## Installation
+
+```bash
+pip install sqlo
+```
+
+## Quick Start
+
+```python
+from sqlo import Q
+
+# SELECT query
+query = Q.select("id", "name").from_("users").where("active", True)
+sql, params = query.build()
+# SQL: SELECT `id`, `name` FROM `users` WHERE `active` = %s
+# Params: (True,)
+
+# INSERT query
+query = Q.insert_into("users").values([
+    {"name": "Alice", "email": "alice@example.com"}
+])
+sql, params = query.build()
+```
+
+## Documentation
+
+Full documentation is available in the [docs](docs/) directory.
+
+- [Getting Started](docs/getting-started.md)
+- [SELECT Queries](docs/select.md)
+- [INSERT Queries](docs/insert.md)
+- [UPDATE Queries](docs/update.md)
+- [DELETE Queries](docs/delete.md)
+- [JOIN Operations](docs/joins.md)
+- [Condition Objects](docs/conditions.md)
+- [Expressions & Functions](docs/expressions.md)
+
+## License
+
+MIT License

sqlo-0.0.1/README.md

@@ -0,0 +1,57 @@
+# sqlo
+
+[![CI](https://github.com/nan-guo/sqlo/actions/workflows/ci.yml/badge.svg)](https://github.com/nan-guo/sqlo/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/sqlo)](https://pypi.org/project/sqlo/)
+[![License](https://img.shields.io/github/license/nan-guo/sqlo)](LICENSE)
+
+
+**sqlo** is a modern, type-safe, and extensible SQL query builder for Python. It allows you to construct complex SQL queries using a fluent, Pythonic API while ensuring safety against SQL injection.
+
+## Features
+
+- 🛡️ **Safe**: Automatic parameter binding prevents SQL injection.
+- 🐍 **Pythonic**: Fluent API design that feels natural to Python developers.
+- 🧩 **Composable**: Build complex queries from reusable parts.
+- 🚀 **Extensible**: Support for custom dialects and functions.
+- 🔍 **Type-Safe**: Designed with type hints for better IDE support.
+
+## Installation
+
+```bash
+pip install sqlo
+```
+
+## Quick Start
+
+```python
+from sqlo import Q
+
+# SELECT query
+query = Q.select("id", "name").from_("users").where("active", True)
+sql, params = query.build()
+# SQL: SELECT `id`, `name` FROM `users` WHERE `active` = %s
+# Params: (True,)
+
+# INSERT query
+query = Q.insert_into("users").values([
+    {"name": "Alice", "email": "alice@example.com"}
+])
+sql, params = query.build()
+```
+
+## Documentation
+
+Full documentation is available in the [docs](docs/) directory.
+
+- [Getting Started](docs/getting-started.md)
+- [SELECT Queries](docs/select.md)
+- [INSERT Queries](docs/insert.md)
+- [UPDATE Queries](docs/update.md)
+- [DELETE Queries](docs/delete.md)
+- [JOIN Operations](docs/joins.md)
+- [Condition Objects](docs/conditions.md)
+- [Expressions & Functions](docs/expressions.md)
+
+## License
+
+MIT License

sqlo-0.0.1/docs/README.md

@@ -0,0 +1,63 @@
+# Documentation Index
+
+sqlo documentation navigation.
+
+## 📚 Documentation Structure
+
+### 🚀 Getting Started
+- **[Getting Started](getting-started.md)** - Installation, basic usage, core concepts
+
+### 📖 Query Types
+- **[SELECT Queries](select.md)** - Complete SELECT functionality (WHERE, ORDER BY, LIMIT, DISTINCT, UNION, etc.)
+- **[INSERT Queries](insert.md)** - Single/batch inserts, INSERT IGNORE, ON DUPLICATE KEY UPDATE  
+- **[UPDATE Queries](update.md)** - UPDATE, SET, WHERE, LIMIT, ORDER BY
+- **[DELETE Queries](delete.md)** - DELETE, WHERE, LIMIT, ORDER BY, safety best practices
+
+### 🔧 SQL Features
+- **[JOIN Operations](joins.md)** - INNER, LEFT, RIGHT, CROSS JOIN and performance optimization
+- **[Condition Objects](conditions.md)** - Condition, ComplexCondition, AND/OR combinations
+- **[Expressions & Functions](expressions.md)** - Raw SQL, Func, FunctionFactory, common functions
+
+## 🎯 Find by Use Case
+
+### I want to...
+
+- **Query data** → [SELECT Queries](select.md)
+- **Insert data** → [INSERT Queries](insert.md)
+- **Update data** → [UPDATE Queries](update.md)
+- **Delete data** → [DELETE Queries](delete.md)
+- **Join multiple tables** → [JOIN Operations](joins.md)
+- **Build complex conditions** → [Condition Objects](conditions.md)
+- **Use SQL functions** → [Expressions & Functions](expressions.md)
+- **Write raw SQL** → [Raw SQL Expressions](expressions.md#raw-sql-expressions)
+
+## 🔗 Quick Links
+
+### Common Features
+- [Basic SELECT](select.md#basic-queries)
+- [WHERE conditions](select.md#where-clauses)
+- [JOIN tables](joins.md)
+- [Batch inserts](insert.md#batch-insert)
+- [Pagination](select.md#limit-and-offset)
+
+### Advanced Features
+- [Complex conditions](conditions.md#complex-combinations)
+- [Subqueries](select.md#subqueries)
+- [UNION](select.md#union)
+- [Index Hints](select.md#index-hints)
+
+### Security
+- [Parameterized queries](getting-started.md#parameterized-queries)
+- [SQL injection protection](expressions.md#safety-notes)
+- [DELETE safety](delete.md#safety-best-practices)
+
+## 🆘 Need Help?
+
+1. **Check examples** - Each document contains rich code examples
+2. **Search docs** - Use Ctrl+F to search for keywords
+3. **Check tests** - `tests/unit/` directory contains more use cases
+4. **Open an issue** - If you find problems or have suggestions
+
+---
+
+**Get started** → [Getting Started](getting-started.md)