sqlspec 0.1.1__tar.gz → 0.4.0__tar.gz

{sqlspec-0.1.1 → sqlspec-0.4.0}/.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.7.1"
+    rev: "v0.8.3"
     hooks:
       - id: ruff
         args: ["--fix"]

{sqlspec-0.1.1 → sqlspec-0.4.0}/CONTRIBUTING.rst

@@ -14,7 +14,7 @@ Code contributions
 Workflow
 ++++++++
 
-1. `Fork <https://github.com/litestar-org/litestar-htmx/fork>`_ the `litestar-htmx repository <https://github.com/litestar-org/litestar-htmx>`_
+1. `Fork <https://github.com/litestar-org/sqlspec/fork>`_ the `sqlspec repository <https://github.com/litestar-org/sqlspec>`_
 2. Clone your fork locally with git
 3. `Set up the environment <#setting-up-the-environment>`_
 4. Make your changes
@@ -59,13 +59,13 @@ You can serve the documentation with ``make docs-serve``, or build them with ``m
 Creating a new release
 ----------------------
 
-1. Increment the version in `pyproject.toml <https://github.com/litestar-org/litestar-htmx/blob/main/pyproject.toml>`_.
+1. Increment the version in `pyproject.toml <https://github.com/litestar-org/sqlspec/blob/main/pyproject.toml>`_.
     .. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
-2. `Draft a new release <https://github.com/litestar-org/litestar-htmx/releases/new>`_ on GitHub
+2. `Draft a new release <https://github.com/litestar-org/sqlspec/releases/new>`_ on GitHub
 
    * Use ``vMAJOR.MINOR.PATCH`` (e.g. ``v1.2.3``) as both the tag and release title
    * Fill in the release description. You can use the "Generate release notes" function to get a draft for this
 3. Commit your changes and push to ``main``
 4. Publish the release
-5. Go to `Actions <https://github.com/litestar-org/litestar-htmx/actions>`_ and approve the release workflow
+5. Go to `Actions <https://github.com/litestar-org/sqlspec/actions>`_ and approve the release workflow
 6. Check that the workflow runs successfully

sqlspec-0.4.0/Makefile

@@ -0,0 +1,229 @@
+SHELL := /bin/bash
+
+# =============================================================================
+# Configuration and Environment Variables
+# =============================================================================
+
+.DEFAULT_GOAL := help
+.ONESHELL:
+.EXPORT_ALL_VARIABLES:
+MAKEFLAGS += --no-print-directory
+
+# -----------------------------------------------------------------------------
+# Display Formatting and Colors
+# -----------------------------------------------------------------------------
+BLUE := $(shell printf "\033[1;34m")
+GREEN := $(shell printf "\033[1;32m")
+RED := $(shell printf "\033[1;31m")
+YELLOW := $(shell printf "\033[1;33m")
+NC := $(shell printf "\033[0m")
+INFO := $(shell printf "$(BLUE)ℹ$(NC)")
+OK := $(shell printf "$(GREEN)✓$(NC)")
+WARN := $(shell printf "$(YELLOW)⚠$(NC)")
+ERROR := $(shell printf "$(RED)✖$(NC)")
+
+# =============================================================================
+# Help and Documentation
+# =============================================================================
+
+.PHONY: help
+help:                                               ## Display this help text for Makefile
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+# =============================================================================
+# Installation and Environment Setup
+# =============================================================================
+
+.PHONY: install-uv
+install-uv:                                         ## Install latest version of uv
+	@echo "${INFO} Installing uv..."
+	@curl -LsSf https://astral.sh/uv/install.sh | sh >/dev/null 2>&1
+	@echo "${OK} UV installed successfully"
+
+.PHONY: install
+install: destroy clean                              ## Install the project, dependencies, and pre-commit
+	@echo "${INFO} Starting fresh installation..."
+	@uv python pin 3.12 >/dev/null 2>&1
+	@uv venv >/dev/null 2>&1
+	@uv sync --all-extras --dev
+	@echo "${OK} Installation complete! 🎉"
+
+.PHONY: destroy
+destroy:                                            ## Destroy the virtual environment
+	@echo "${INFO} Destroying virtual environment... 🗑️"
+	@uv run pre-commit clean >/dev/null 2>&1
+	@rm -rf .venv
+	@echo "${OK} Virtual environment destroyed 🗑️"
+
+# =============================================================================
+# Dependency Management
+# =============================================================================
+
+.PHONY: upgrade
+upgrade:                                            ## Upgrade all dependencies to latest stable versions
+	@echo "${INFO} Updating all dependencies... 🔄"
+	@uv lock --upgrade
+	@echo "${OK} Dependencies updated 🔄"
+	@uv run pre-commit autoupdate
+	@echo "${OK} Updated Pre-commit hooks 🔄"
+
+.PHONY: lock
+lock:                                              ## Rebuild lockfiles from scratch
+	@echo "${INFO} Rebuilding lockfiles... 🔄"
+	@uv lock --upgrade >/dev/null 2>&1
+	@echo "${OK} Lockfiles updated"
+
+# =============================================================================
+# Build and Release
+# =============================================================================
+
+.PHONY: build
+build:                                             ## Build the package
+	@echo "${INFO} Building package... 📦"
+	@uv build >/dev/null 2>&1
+	@echo "${OK} Package build complete"
+
+.PHONY: release
+release:                                           ## Bump version and create release tag
+	@echo "${INFO} Preparing for release... 📦"
+	@make docs
+	@make clean
+	@make build
+	@uv lock --upgrade-package litestar-vite >/dev/null 2>&1
+	@uv run bump-my-version bump $(bump)
+	@echo "${OK} Release complete 🎉"
+
+# =============================================================================
+# Cleaning and Maintenance
+# =============================================================================
+
+.PHONY: clean
+clean:                                              ## Cleanup temporary build artifacts
+	@echo "${INFO} Cleaning working directory... 🧹"
+	@rm -rf .pytest_cache .ruff_cache .hypothesis build/ -rf dist/ .eggs/ .coverage coverage.xml coverage.json htmlcov/ .pytest_cache tests/.pytest_cache tests/**/.pytest_cache .mypy_cache .unasyncd_cache/ .auto_pytabs_cache >/dev/null 2>&1
+	@find . -name '*.egg-info' -exec rm -rf {} + >/dev/null 2>&1
+	@find . -type f -name '*.egg' -exec rm -f {} + >/dev/null 2>&1
+	@find . -name '*.pyc' -exec rm -f {} + >/dev/null 2>&1
+	@find . -name '*.pyo' -exec rm -f {} + >/dev/null 2>&1
+	@find . -name '*~' -exec rm -f {} + >/dev/null 2>&1
+	@find . -name '__pycache__' -exec rm -rf {} + >/dev/null 2>&1
+	@find . -name '.ipynb_checkpoints' -exec rm -rf {} + >/dev/null 2>&1
+	@echo "${OK} Working directory cleaned"
+	$(MAKE) docs-clean
+
+# =============================================================================
+# Testing and Quality Checks
+# =============================================================================
+
+.PHONY: test
+test:                                               ## Run the tests
+	@echo "${INFO} Running test cases... 🧪"
+	@uv run pytest tests
+	@echo "${OK} Tests complete ✨"
+
+.PHONY: test-examples
+test-examples:                                      ## Run the examples tests
+	@echo "${INFO} Running example tests... 🧪"
+	@uv run pytest docs/examples
+	@echo "${OK} Example tests complete ✨"
+
+.PHONY: test-all
+test-all: test test-examples                        ## Run all tests
+	@echo "${INFO} All tests executed successfully ✨"
+
+.PHONY: coverage
+coverage:                                          ## Run tests with coverage report
+	@echo "${INFO} Running tests with coverage... 📊"
+	@uv run pytest tests --cov -n auto --quiet
+	@uv run coverage html >/dev/null 2>&1
+	@uv run coverage xml >/dev/null 2>&1
+	@echo "${OK} Coverage report generated ✨"
+
+.PHONY: mypy
+mypy:                                               ## Run mypy
+	@echo "${INFO} Running mypy... 🔍"
+	@uv run dmypy run
+	@echo "${OK} mypy complete ✨"
+
+.PHONY: mypy-nocache
+mypy-nocache:                                       ## Run Mypy without cache
+	@echo "${INFO} Running mypy without cache... 🔍"
+	@uv run mypy
+	@echo "${OK} mypy complete ✨"
+
+.PHONY: pyright
+pyright:                                            ## Run pyright
+	@echo "${INFO} Running pyright... 🔍"
+	@uv run pyright
+	@echo "${OK} pyright complete ✨"
+
+.PHONY: type-check
+type-check: mypy pyright                            ## Run all type checking
+	@echo "${OK} All type checks passed ✨"
+
+# -----------------------------------------------------------------------------
+# Linting and Formatting
+# -----------------------------------------------------------------------------
+
+.PHONY: pre-commit
+pre-commit:                                        ## Run pre-commit hooks
+	@echo "${INFO} Running pre-commit checks... 🔎"
+	@uv run pre-commit run --color=always --all-files
+	@echo "${OK} Pre-commit checks passed ✨"
+
+.PHONY: slotscheck
+slotscheck:                                        ## Run slotscheck
+	@echo "${INFO} Running slotscheck... 🔍"
+	@uv run slotscheck sqlspec/
+	@echo "${OK} Slotscheck complete ✨"
+
+.PHONY: fix
+fix:                                               ## Run code formatters
+	@echo "${INFO} Running code formatters... 🔧"
+	@uv run ruff check --fix --unsafe-fixes
+	@echo "${OK} Code formatting complete ✨"
+
+.PHONY: lint
+lint: fix pre-commit type-check slotscheck             ## Run all linting checks
+	@echo "${OK} All linting checks passed ✨"
+
+.PHONY: check-all
+check-all: lint test-all coverage                  ## Run all checks (lint, test, coverage)
+	@echo "${OK} All checks passed successfully ✨"
+
+# =============================================================================
+# Documentation
+# =============================================================================
+
+.PHONY: docs-clean
+docs-clean:                                        ## Clean documentation build
+	@echo "${INFO} Cleaning documentation build assets... 🧹"
+	@rm -rf docs/_build >/dev/null 2>&1
+	@echo "${OK} Documentation assets cleaned"
+
+.PHONY: docs-serve
+docs-serve: docs-clean                             ## Serve documentation locally
+	@echo "${INFO} Starting documentation server... 📚"
+	@uv run sphinx-autobuild docs docs/_build/ -j auto --watch sqlspec --watch docs --watch tests --watch CONTRIBUTING.rst --port 8002
+
+.PHONY: docs
+docs: docs-clean                                   ## Build documentation
+	@echo "${INFO} Building documentation... 📝"
+	@uv run sphinx-build -M html docs docs/_build/ -E -a -j auto -W --keep-going >/dev/null 2>&1
+	@echo "${OK} Documentation built successfully"
+
+.PHONY: docs-linkcheck
+docs-linkcheck:                                    ## Check documentation links
+	@echo "${INFO} Checking documentation links... 🔗"
+	@uv run sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_ignore='http://.*','https://.*'
+	@echo "${OK} Link check complete"
+
+.PHONY: docs-linkcheck-full
+docs-linkcheck-full:                               ## Run full documentation link check
+	@echo "${INFO} Running full link check... 🔗"
+	@uv run sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_anchors=0
+	@echo "${OK} Full link check complete"
+
+# =============================================================================
+# End of Makefile
+# =============================================================================

sqlspec-0.4.0/NOTICE

@@ -0,0 +1,29 @@
+# Early versions of this utility adapt code from `aoisql`.
+# BSD 2-Clause License
+Copyright (c) 2014-2017, Honza Pokorny
+Copyright (c) 2018, William Vaughn
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the aiosql Project.

sqlspec-0.4.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: sqlspec
+Version: 0.4.0
+Summary: SQL Experiments in Python
+Author-email: Cody Fincher <cody@litestar.dev>
+Maintainer-email: Litestar Developers <hello@litestar.dev>
+License-File: NOTICE
+Requires-Python: <4.0,>=3.9
+Requires-Dist: eval-type-backport; python_version <= '3.9'
+Requires-Dist: sqlglot
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: adbc
+Requires-Dist: adbc-driver-manager; extra == 'adbc'
+Requires-Dist: pyarrow; extra == 'adbc'
+Provides-Extra: aioodbc
+Requires-Dist: aioodbc; extra == 'aioodbc'
+Provides-Extra: aiosqlite
+Requires-Dist: aiosqlite; extra == 'aiosqlite'
+Provides-Extra: asyncmy
+Requires-Dist: asyncmy; extra == 'asyncmy'
+Provides-Extra: asyncpg
+Requires-Dist: asyncpg; extra == 'asyncpg'
+Provides-Extra: bigquery
+Requires-Dist: google-cloud-bigquery; extra == 'bigquery'
+Provides-Extra: duckdb
+Requires-Dist: duckdb; extra == 'duckdb'
+Provides-Extra: fastapi
+Requires-Dist: fastapi; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask; extra == 'flask'
+Provides-Extra: litestar
+Requires-Dist: litestar; extra == 'litestar'
+Provides-Extra: msgspec
+Requires-Dist: msgspec; extra == 'msgspec'
+Provides-Extra: oracledb
+Requires-Dist: oracledb; extra == 'oracledb'
+Provides-Extra: performance
+Requires-Dist: google-re2; (sys_platform == 'linux') and extra == 'performance'
+Requires-Dist: sqlglot[rs]; extra == 'performance'
+Provides-Extra: psycopg
+Requires-Dist: psycopg[binary,pool]; extra == 'psycopg'
+Provides-Extra: pydantic
+Requires-Dist: pydantic; extra == 'pydantic'
+Provides-Extra: pymssql
+Requires-Dist: pymssql; extra == 'pymssql'
+Provides-Extra: pymysql
+Requires-Dist: pymysql; extra == 'pymysql'
+Provides-Extra: spanner
+Requires-Dist: google-cloud-spanner; extra == 'spanner'
+Description-Content-Type: text/markdown
+
+<!-- markdownlint-disable -->
+<p align="center">
+  <!-- github-banner-start -->
+  <img src="https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Light.svg#gh-light-mode-only" alt="Litestar Logo - Light" width="100%" height="auto" />
+  <img src="https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Dark.svg#gh-dark-mode-only" alt="Litestar Logo - Dark" width="100%" height="auto" />
+  <!-- github-banner-end -->
+
+</p>
+<div align="center">
+<!-- markdownlint-restore -->
+
+# SQLSpec
+
+SQL Experiments in Python
+
+
+## Minimal SQL Abstractions for Python.
+
+- Modern: Typed and Extensible
+- Multi-database: SQLite, Postgres, DuckDB, MySQL, Oracle, SQL Server, Spanner, Big Query, and more...
+- Easy ability to manipulate and add filters to queries
+- Validate and Convert between dialects with `sqlglot`
+- and more...
+
+## Can it do `X`?
+
+- Probably not currently; but, if it makes sense we can add enhancements.
+
+## Inspiration
+
+`aiosql` is the primary influence for this library.  However, I wanted to be able to use the query interface from `aiosql` a bit more flexibly.
+
+Why not add it to `aiosql`?  Where it makes sense, many of these changes will likely get submitted to aiosql as a PR (`spanner` and `bigquery` drivers are likely the starting point.)

sqlspec-0.4.0/README.md

@@ -0,0 +1,33 @@
+<!-- markdownlint-disable -->
+<p align="center">
+  <!-- github-banner-start -->
+  <img src="https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Light.svg#gh-light-mode-only" alt="Litestar Logo - Light" width="100%" height="auto" />
+  <img src="https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Dark.svg#gh-dark-mode-only" alt="Litestar Logo - Dark" width="100%" height="auto" />
+  <!-- github-banner-end -->
+
+</p>
+<div align="center">
+<!-- markdownlint-restore -->
+
+# SQLSpec
+
+SQL Experiments in Python
+
+
+## Minimal SQL Abstractions for Python.
+
+- Modern: Typed and Extensible
+- Multi-database: SQLite, Postgres, DuckDB, MySQL, Oracle, SQL Server, Spanner, Big Query, and more...
+- Easy ability to manipulate and add filters to queries
+- Validate and Convert between dialects with `sqlglot`
+- and more...
+
+## Can it do `X`?
+
+- Probably not currently; but, if it makes sense we can add enhancements.
+
+## Inspiration
+
+`aiosql` is the primary influence for this library.  However, I wanted to be able to use the query interface from `aiosql` a bit more flexibly.
+
+Why not add it to `aiosql`?  Where it makes sense, many of these changes will likely get submitted to aiosql as a PR (`spanner` and `bigquery` drivers are likely the starting point.)