excel-dbapi 0.1.4__tar.gz → 0.2.0__tar.gz

excel_dbapi-0.2.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Report a reproducible problem in excel-dbapi
+labels: bug
+---
+
+## Summary
+
+<!-- concise description -->
+
+## Reproduction
+
+1.
+2.
+3.
+
+## Expected behavior
+
+## Actual behavior
+
+## Environment
+
+- excel-dbapi version:
+- Python version:
+- OS:
+- Engine: openpyxl / pandas
+
+## Sample code / logs
+
+```text
+paste traceback or snippet
+```

excel_dbapi-0.2.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an enhancement aligned with project boundaries
+labels: enhancement
+---
+
+## Problem statement
+
+## Proposed solution
+
+## Alternatives considered
+
+## Scope check
+
+- [ ] This does not require full SQL-engine behavior (JOIN/GROUP BY/subquery)
+- [ ] This fits DB-API style Excel workflows

excel_dbapi-0.2.0/.github/ISSUE_TEMPLATE/release_checklist.md

@@ -0,0 +1,23 @@
+---
+name: Release checklist
+about: Track release prep
+labels: release
+---
+
+## Version
+
+- [ ] VERSION updated
+- [ ] pyproject.toml version updated
+- [ ] CHANGELOG updated
+- [ ] Tag planned (`vX.Y.Z`)
+
+## Validation
+
+- [ ] CI green
+- [ ] Coverage artifact generated (`coverage.xml`)
+- [ ] `python -m build` passes
+
+## Publish
+
+- [ ] Trusted Publishing environment configured
+- [ ] Release notes drafted

excel_dbapi-0.2.0/.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## Summary
+
+## Related issue
+
+Fixes #
+
+## Checklist
+
+- [ ] Focused change (no unrelated refactor)
+- [ ] Tests added/updated
+- [ ] Docs updated if behavior changed
+- [ ] `pytest` passes locally
+- [ ] Boundary maintained (not expanding to full SQL engine)

excel_dbapi-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: ci
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev,pandas]"
+      - name: Run tests with coverage
+        run: pytest tests/ -v --cov=excel_dbapi --cov-report=xml --cov-report=term-missing
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+      - name: Run ruff
+        run: ruff check src/
+      - name: Run ruff format check
+        run: ruff format --check src/
+      - name: Run mypy strict
+        run: mypy --strict src/

excel_dbapi-0.2.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,28 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

excel_dbapi-0.2.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.pyc
+*.py[cod]
+*.so
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Tool caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+
+# Data files
+*.xlsx
+!tests/data/*.xlsx
+
+# IDE
+.vscode/
+.idea/
+
+# OS
+.DS_Store

excel_dbapi-0.2.0/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2026-04-12
+
+### Added
+- PEP 249 (DB-API 2.0) compliant driver for Excel files
+- SQL support: SELECT, INSERT, UPDATE, DELETE, CREATE TABLE, DROP TABLE
+- WHERE clauses with AND/OR, comparison operators, LIKE, IN, IS NULL/IS NOT NULL
+- ORDER BY and LIMIT for SELECT queries
+- Openpyxl engine (default) for local .xlsx files
+- Pandas engine (optional) for DataFrame-based operations
+- Microsoft Graph API engine (optional) for remote Excel files
+- Formula injection defense (enabled by default)
+- Transaction simulation (commit/rollback)
+- Reflection helpers for dialect integration
+- Metadata sheet support for schema persistence

excel_dbapi-0.2.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: excel-dbapi
+Version: 0.2.0
+Summary: PEP 249 compliant DB-API driver for Excel files
+Project-URL: Homepage, https://github.com/yeongseon/excel-dbapi
+Project-URL: Repository, https://github.com/yeongseon/excel-dbapi
+Project-URL: Issues, https://github.com/yeongseon/excel-dbapi/issues
+Project-URL: Changelog, https://github.com/yeongseon/excel-dbapi/blob/main/CHANGELOG.md
+Author-email: Yeongseon Choe <yeongseon.choe@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: db-api,excel,openpyxl,pandas,sql
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: openpyxl<4.0.0,>=3.1.0
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: graph
+Requires-Dist: httpx>=0.27; extra == 'graph'
+Provides-Extra: graph-azure
+Requires-Dist: azure-identity>=1.15; extra == 'graph-azure'
+Requires-Dist: httpx>=0.27; extra == 'graph-azure'
+Provides-Extra: pandas
+Requires-Dist: pandas<3.0.0,>=2.0.0; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+
+# excel-dbapi
+
+![CI](https://github.com/yeongseon/excel-dbapi/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/yeongseon/excel-dbapi/branch/main/graph/badge.svg)](https://codecov.io/gh/yeongseon/excel-dbapi)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+A lightweight, Python DB-API 2.0 compliant connector for Excel files.
+Use SQL to query, insert, update, and delete rows in `.xlsx` workbooks — no database server required.
+
+## Who is this for?
+
+- **Data analysts** who want to query Excel files with SQL instead of manual filtering
+- **Citizen developers** automating small workflows with familiar SQL syntax
+- **Educators** teaching SQL concepts without setting up a database
+- **Prototypers** building quick data pipelines before moving to a real database
+
+### Who is this NOT for?
+
+- If you need JOINs, GROUP BY, subqueries, or advanced SQL → use SQLite or PostgreSQL
+- If you need concurrent writes from multiple processes → use a real database
+- If your Excel file has 100k+ rows → use pandas directly or a database
+
+---
+
+## Features
+
+- Python DB-API 2.0 compliant interface (PEP 249)
+- Query Excel files using SQL syntax
+- Supports SELECT, INSERT, UPDATE, DELETE
+- Basic DDL support (CREATE TABLE, DROP TABLE)
+- WHERE conditions with AND/OR and comparison operators
+- ORDER BY and LIMIT for SELECT
+- Sheet-to-Table mapping
+- Pandas & Openpyxl engine selector
+- Formula injection defense (enabled by default)
+- Transaction simulation (commit/rollback)
+
+---
+
+## Installation
+
+```bash
+pip install excel-dbapi
+```
+
+See [CHANGELOG](CHANGELOG.md) for release history.
+
+---
+
+## Quick Start
+
+```python
+from excel_dbapi.connection import ExcelConnection
+
+# Open an Excel file and query it
+with ExcelConnection("sample.xlsx") as conn:
+    cursor = conn.cursor()
+    cursor.execute("SELECT * FROM Sheet1")
+    print(cursor.fetchall())
+```
+
+### Insert, Update, Delete
+
+```python
+with ExcelConnection("sample.xlsx") as conn:
+    cursor = conn.cursor()
+
+    # Insert with parameter binding (recommended)
+    cursor.execute("INSERT INTO Sheet1 (id, name) VALUES (?, ?)", (1, "Alice"))
+
+    # Update
+    cursor.execute("UPDATE Sheet1 SET name = 'Ann' WHERE id = 1")
+
+    # Delete
+    cursor.execute("DELETE FROM Sheet1 WHERE id = 2")
+```
+
+### Create and Drop Sheets
+
+```python
+with ExcelConnection("sample.xlsx") as conn:
+    cursor = conn.cursor()
+    cursor.execute("CREATE TABLE NewSheet (id, name)")
+    cursor.execute("DROP TABLE NewSheet")
+```
+
+### Engine Options
+
+| Engine | Description | Dependency |
+|--------|-------------|------------|
+| openpyxl (default) | Fast sheet access | openpyxl |
+| pandas | DataFrame-based operations | pandas, openpyxl |
+
+```python
+conn = ExcelConnection("sample.xlsx", engine="openpyxl")  # default
+conn = ExcelConnection("sample.xlsx", engine="pandas")
+```
+
+---
+
+## Safety Defaults
+
+### Formula Injection Defense
+
+By default, `excel-dbapi` sanitizes cell values on write (INSERT/UPDATE) to prevent
+[formula injection attacks](https://owasp.org/www-community/attacks/CSV_Injection).
+Strings starting with `=`, `+`, `-`, `@`, `\t`, or `\r` are automatically prefixed
+with a single quote (`'`) so they are stored as plain text, not executed as formulas.
+
+```python
+# Default: sanitization ON (recommended)
+with ExcelConnection("sample.xlsx") as conn:
+    cursor = conn.cursor()
+    cursor.execute("INSERT INTO Sheet1 (id, name) VALUES (?, ?)",
+                   (1, "=SUM(A1:A10)"))
+    # Stored as: '=SUM(A1:A10)  (safe, not executed as formula)
+
+# Opt out if you intentionally write formulas
+with ExcelConnection("sample.xlsx", sanitize_formulas=False) as conn:
+    cursor = conn.cursor()
+    cursor.execute("INSERT INTO Sheet1 (id, formula) VALUES (?, ?)",
+                   (1, "=SUM(A1:A10)"))
+    # Stored as: =SUM(A1:A10)  (executed as formula in Excel)
+```
+
+---
+
+## Transaction Example
+
+```python
+with ExcelConnection("sample.xlsx", autocommit=False) as conn:
+    cursor = conn.cursor()
+    cursor.execute("UPDATE Sheet1 SET name = 'Ann' WHERE id = 1")
+    conn.rollback()
+```
+
+When autocommit is enabled, `rollback()` is not supported.
+
+## Cursor Metadata
+
+```python
+with ExcelConnection("sample.xlsx") as conn:
+    cursor = conn.cursor()
+    cursor.execute("SELECT id, name FROM Sheet1")
+    print(cursor.description)
+    print(cursor.rowcount)
+```
+
+---
+
+## Troubleshooting
+
+### "Column 'xyz' not found"
+
+The column name in your SQL doesn't match any header in the sheet.
+
+```
+ProgrammingError: Column 'nmae' not found in Sheet1. Available columns: ['id', 'name', 'email']
+```
+
+**Fix:** Check the spelling. Column names must match the first row (header) of the sheet exactly.
+
+### "Table 'SheetX' not found"
+
+The sheet name in your SQL doesn't match any sheet in the workbook.
+
+```
+ProgrammingError: Table 'Shee1' not found. Available sheets: ['Sheet1', 'Sheet2']
+```
+
+**Fix:** Check the sheet name spelling. Use the exact sheet name (case-sensitive) shown in your Excel file.
+
+### PandasEngine drops formatting
+
+`PandasEngine` reads data into a DataFrame and writes it back. This process drops
+Excel formatting, charts, images, and formulas.
+
+**Fix:** Use the default `openpyxl` engine if you need to preserve formatting.
+
+### Integer vs. string comparison (Pandas)
+
+The Pandas engine preserves Python types. If a column contains integers,
+`WHERE id = '2'` (string) won't match — use `WHERE id = 2` (no quotes).
+
+**Fix:** Omit quotes around numeric values in WHERE clauses when using the Pandas engine.
+
+---
+
+## Limitations and Operational Guidance
+
+- `PandasEngine` rewrites workbooks and may drop formatting, charts, and formulas.
+- `OpenpyxlEngine` loads with `data_only=True`, so formulas are evaluated to values when reading.
+- Use a **single-writer model** for writes. Avoid writing to the same file from multiple processes.
+- Save is implemented with a temporary file + atomic replace (`os.replace`) for safer persistence.
+- No support for JOIN, GROUP BY, HAVING, or subqueries.
+
+## Roadmap
+
+- Remote file connection improvements
+
+See [Project Roadmap](docs/ROADMAP.md) for details.
+
+---
+
+
+## Related Projects
+
+### sqlalchemy-excel
+
+[sqlalchemy-excel](https://github.com/yeongseon/sqlalchemy-excel) is a higher-level toolkit that uses excel-dbapi as its core Excel I/O layer. It provides SQLAlchemy model-driven template generation, server-side validation, database import, and export.
+
+- **Which package should I use?** See the [decision guide](https://github.com/yeongseon/sqlalchemy-excel/blob/main/docs/which-package.md)
+- **Interface contract**: See the [compatibility documentation](https://github.com/yeongseon/sqlalchemy-excel/blob/main/docs/compatibility.md)
+
+---
+
+## Documentation
+
+- [Usage Guide](docs/USAGE.md)
+- [Development Guide](docs/DEVELOPMENT.md)
+- [Project Roadmap](docs/ROADMAP.md)
+- [10-Minute Quickstart](docs/QUICKSTART_10_MIN.md)
+- [Operations Notes](docs/OPERATIONS.md)
+- [Public Roadmap](docs/PUBLIC_ROADMAP.md)
+
+## Examples
+
+- `examples/basic_usage.py`
+- `examples/write_operations.py`
+- `examples/transactions.py`
+- `examples/advanced_query.py`
+- `examples/pandas_engine.py`
+
+---
+
+## License
+
+MIT License