sqliter-py 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

sqliter/constants.py

@@ -0,0 +1,20 @@
+"""Define constants used in the library."""
+
+OPERATOR_MAPPING = {
+    "__lt": "<",
+    "__lte": "<=",
+    "__gt": ">",
+    "__gte": ">=",
+    "__eq": "=",
+    "__ne": "!=",
+    "__in": "IN",
+    "__not_in": "NOT IN",
+    "__isnull": "IS NULL",
+    "__notnull": "IS NOT NULL",
+    "__startswith": "LIKE",
+    "__endswith": "LIKE",
+    "__contains": "LIKE",
+    "__istartswith": "LIKE",
+    "__iendswith": "LIKE",
+    "__icontains": "LIKE",
+}

sqliter/exceptions.py

@@ -0,0 +1,120 @@
+"""Define custom exceptions for the sqliter package."""
+
+import os
+import sys
+import traceback
+
+
+class SqliterError(Exception):
+    """Base class for all exceptions raised by the sqliter package."""
+
+    message_template: str = "An error occurred in the SQLiter package."
+
+    def __init__(self, *args: object) -> None:
+        """Format the message using the provided arguments.
+
+        We also capture (and display) the current exception context and chain
+        any previous exceptions.
+
+        :param args: Arguments to format into the message template
+        """
+        if args:
+            message = self.message_template.format(*args)
+        else:
+            message = (
+                self.message_template.replace("'{}'", "")
+                .replace(":", "")
+                .strip()
+            )
+
+        # Capture the current exception context
+        self.original_exception = sys.exc_info()[1]
+
+        # If there's an active exception, append its information to our message
+        if self.original_exception:
+            original_type = type(self.original_exception).__name__
+            original_module = type(self.original_exception).__module__
+
+            # Get the traceback of the original exception
+            tb = traceback.extract_tb(self.original_exception.__traceback__)
+            if tb:
+                last_frame = tb[-1]
+                file_path = os.path.relpath(last_frame.filename)
+                line_number = last_frame.lineno
+                location = f"{file_path}:{line_number}"
+            else:
+                location = "unknown location"
+
+            message += (
+                f"\n  --> {original_module}.{original_type} "
+                f"from {location}: {self.original_exception}"
+            )
+
+        # Call the parent constructor with our formatted message
+        super().__init__(message)
+
+        # Explicitly chain exceptions if there's an active one
+        if self.original_exception:
+            self.__cause__ = self.original_exception
+
+
+class DatabaseConnectionError(SqliterError):
+    """Raised when the SQLite database connection fails."""
+
+    message_template = "Failed to connect to the database: '{}'"
+
+
+class InvalidOffsetError(SqliterError):
+    """Raised when an invalid offset value (0 or negative) is used."""
+
+    message_template = (
+        "Invalid offset value: '{}'. Offset must be a positive integer."
+    )
+
+
+class InvalidOrderError(SqliterError):
+    """Raised when an invalid order value is used."""
+
+    message_template = "Invalid order value - {}"
+
+
+class TableCreationError(SqliterError):
+    """Raised when a table cannot be created in the database."""
+
+    message_template = "Failed to create the table: '{}'"
+
+
+class RecordInsertionError(SqliterError):
+    """Raised when an error occurs during record insertion."""
+
+    message_template = "Failed to insert record into table: '{}'"
+
+
+class RecordUpdateError(SqliterError):
+    """Raised when an error occurs during record update."""
+
+    message_template = "Failed to update record in table: '{}'"
+
+
+class RecordNotFoundError(SqliterError):
+    """Raised when a record with the specified primary key is not found."""
+
+    message_template = "Failed to find a record for key '{}' "
+
+
+class RecordFetchError(SqliterError):
+    """Raised when an error occurs during record fetching."""
+
+    message_template = "Failed to fetch record from table: '{}'"
+
+
+class RecordDeletionError(SqliterError):
+    """Raised when an error occurs during record deletion."""
+
+    message_template = "Failed to delete record from table: '{}'"
+
+
+class InvalidFilterError(SqliterError):
+    """Raised when an invalid filter field is used in a query."""
+
+    message_template = "Failed to apply filter: invalid field '{}'"

sqliter/query/query.py

@@ -2,14 +2,30 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Optional
+import sqlite3
+from typing import TYPE_CHECKING, Any, Callable, Optional, Union
 
-from typing_extensions import Self
+from typing_extensions import LiteralString, Self
+
+from sqliter.constants import OPERATOR_MAPPING
+from sqliter.exceptions import (
+    InvalidFilterError,
+    InvalidOffsetError,
+    InvalidOrderError,
+    RecordFetchError,
+)
+
+if TYPE_CHECKING:  # pragma: no cover
+    from pydantic.fields import FieldInfo
 
-if TYPE_CHECKING:
     from sqliter import SqliterDB
     from sqliter.model import BaseDBModel
 
+# Define a type alias for the possible value types
+FilterValue = Union[
+    str, int, float, bool, None, list[Union[str, int, float, bool]]
+]
+
 
 class QueryBuilder:
     """Functions to build and execute queries for a given model."""
@@ -19,53 +35,245 @@ class QueryBuilder:
         self.db = db
         self.model_class = model_class
         self.table_name = model_class.get_table_name()  # Use model_class method
-        self.filters: list[tuple[str, Any]] = []
+        self.filters: list[tuple[str, Any, str]] = []
+        self._limit: Optional[int] = None
+        self._offset: Optional[int] = None
+        self._order_by: Optional[str] = None
 
-    def filter(self, **conditions: str | float | None) -> Self:
+    def filter(self, **conditions: str | float | None) -> QueryBuilder:
         """Add filter conditions to the query."""
+        valid_fields = self.model_class.model_fields
+
         for field, value in conditions.items():
-            self.filters.append((field, value))
+            field_name, operator = self._parse_field_operator(field)
+            self._validate_field(field_name, valid_fields)
+
+            handler = self._get_operator_handler(operator)
+            handler(field_name, value, operator)
+
+        return self
+
+    def _get_operator_handler(
+        self, operator: str
+    ) -> Callable[[str, Any, str], None]:
+        handlers = {
+            "__isnull": self._handle_null,
+            "__notnull": self._handle_null,
+            "__in": self._handle_in,
+            "__not_in": self._handle_in,
+            "__startswith": self._handle_like,
+            "__endswith": self._handle_like,
+            "__contains": self._handle_like,
+            "__istartswith": self._handle_like,
+            "__iendswith": self._handle_like,
+            "__icontains": self._handle_like,
+            "__lt": self._handle_comparison,
+            "__lte": self._handle_comparison,
+            "__gt": self._handle_comparison,
+            "__gte": self._handle_comparison,
+            "__ne": self._handle_comparison,
+        }
+        return handlers.get(operator, self._handle_equality)
+
+    def _validate_field(
+        self, field_name: str, valid_fields: dict[str, FieldInfo]
+    ) -> None:
+        if field_name not in valid_fields:
+            raise InvalidFilterError(field_name)
+
+    def _handle_equality(
+        self, field_name: str, value: FilterValue, operator: str
+    ) -> None:
+        if value is None:
+            self.filters.append((f"{field_name} IS NULL", None, "__isnull"))
+        else:
+            self.filters.append((field_name, value, operator))
+
+    def _handle_null(
+        self, field_name: str, _: FilterValue, operator: str
+    ) -> None:
+        condition = (
+            f"{field_name} IS NOT NULL"
+            if operator == "__notnull"
+            else f"{field_name} IS NULL"
+        )
+        self.filters.append((condition, None, operator))
+
+    def _handle_in(
+        self, field_name: str, value: FilterValue, operator: str
+    ) -> None:
+        if not isinstance(value, list):
+            err = f"{field_name} requires a list for '{operator}'"
+            raise TypeError(err)
+        sql_operator = OPERATOR_MAPPING.get(operator, "IN")
+        placeholder_list = ", ".join(["?"] * len(value))
+        self.filters.append(
+            (
+                f"{field_name} {sql_operator} ({placeholder_list})",
+                value,
+                operator,
+            )
+        )
+
+    def _handle_like(
+        self, field_name: str, value: FilterValue, operator: str
+    ) -> None:
+        if not isinstance(value, str):
+            err = f"{field_name} requires a string value for '{operator}'"
+            raise TypeError(err)
+        formatted_value = self._format_string_for_operator(operator, value)
+        if operator in ["__startswith", "__endswith", "__contains"]:
+            self.filters.append(
+                (
+                    f"{field_name} GLOB ?",
+                    [formatted_value],
+                    operator,
+                )
+            )
+        elif operator in ["__istartswith", "__iendswith", "__icontains"]:
+            self.filters.append(
+                (
+                    f"{field_name} LIKE ?",
+                    [formatted_value],
+                    operator,
+                )
+            )
+
+    def _handle_comparison(
+        self, field_name: str, value: FilterValue, operator: str
+    ) -> None:
+        sql_operator = OPERATOR_MAPPING[operator]
+        self.filters.append((f"{field_name} {sql_operator} ?", value, operator))
+
+    # Helper method for parsing field and operator
+    def _parse_field_operator(self, field: str) -> tuple[str, str]:
+        for operator in OPERATOR_MAPPING:
+            if field.endswith(operator):
+                return field[: -len(operator)], operator
+        return field, "__eq"  # Default to equality if no operator is found
+
+    # Helper method for formatting string operators (like startswith)
+    def _format_string_for_operator(self, operator: str, value: str) -> str:
+        # Mapping operators to their corresponding string format
+        format_map = {
+            "__startswith": f"{value}*",
+            "__endswith": f"*{value}",
+            "__contains": f"*{value}*",
+            "__istartswith": f"{value.lower()}%",
+            "__iendswith": f"%{value.lower()}",
+            "__icontains": f"%{value.lower()}%",
+        }
+
+        # Return the formatted string or the original value if no match
+        return format_map.get(operator, value)
+
+    def limit(self, limit_value: int) -> Self:
+        """Limit the number of results returned by the query."""
+        self._limit = limit_value
+        return self
+
+    def offset(self, offset_value: int) -> Self:
+        """Set an offset value for the query."""
+        if offset_value < 0:
+            raise InvalidOffsetError(offset_value)
+        self._offset = offset_value
+
+        if self._limit is None:
+            self._limit = -1
+        return self
+
+    def order(self, order_by_field: str, direction: str = "ASC") -> Self:
+        """Order the results by a specific field and optionally direction.
+
+        Currently only supports ordering by a single field, though this will be
+        expanded in the future. You can chain this method to order by multiple
+        fields.
+
+        Parameters:
+            order_by_field (str): The field to order by.
+            direction (str, optional): The sorting direction, either 'ASC' or
+                'DESC'. Defaults to 'ASC'.
+
+        Returns:
+            Self: Returns the query object for chaining.
+
+        Raises:
+            InvalidOrderError: If the field or direction is invalid.
+        """
+        if order_by_field not in self.model_class.model_fields:
+            err = f"'{order_by_field}' does not exist in the model fields."
+            raise InvalidOrderError(err)
+
+        valid_directions = {"ASC", "DESC"}
+        if direction.upper() not in valid_directions:
+            err = f"'{direction}' is not a valid sorting direction."
+            raise InvalidOrderError(err)
+
+        self._order_by = f'"{order_by_field}" {direction.upper()}'
         return self
 
     def _execute_query(
         self,
-        limit: Optional[int] = None,
-        offset: Optional[int] = None,
-        order_by: Optional[str] = None,
         *,
         fetch_one: bool = False,
+        count_only: bool = False,
     ) -> list[tuple[Any, ...]] | Optional[tuple[Any, ...]]:
         """Helper function to execute the query with filters."""
         fields = ", ".join(self.model_class.model_fields)
-        where_clause = " AND ".join(
-            [f"{field} = ?" for field, _ in self.filters]
-        )
-        sql = f"SELECT {fields} FROM {self.table_name}"  # noqa: S608
+
+        # Build the WHERE clause with special handling for None (NULL in SQL)
+        values, where_clause = self._parse_filter()
+
+        select_fields = fields if not count_only else "COUNT(*)"
+
+        sql = f'SELECT {select_fields} FROM "{self.table_name}"'  # noqa: S608 # nosec
 
         if self.filters:
             sql += f" WHERE {where_clause}"
 
-        if order_by:
-            sql += f" ORDER BY {order_by}"
+        if self._order_by:
+            sql += f" ORDER BY {self._order_by}"
+
+        if self._limit is not None:
+            sql += " LIMIT ?"
+            values.append(self._limit)
 
-        if limit is not None:
-            sql += f" LIMIT {limit}"
+        if self._offset is not None:
+            sql += " OFFSET ?"
+            values.append(self._offset)
 
-        if offset is not None:
-            sql += f" OFFSET {offset}"
+        try:
+            with self.db.connect() as conn:
+                cursor = conn.cursor()
+                cursor.execute(sql, values)
+                return cursor.fetchall() if not fetch_one else cursor.fetchone()
+        except sqlite3.Error as exc:
+            raise RecordFetchError(self.table_name) from exc
 
-        values = [value for _, value in self.filters]
+    def _parse_filter(self) -> tuple[list[Any], LiteralString]:
+        """Actually parse the filters."""
+        where_clauses = []
+        values = []
+        for field, value, operator in self.filters:
+            if operator == "__eq":
+                where_clauses.append(f"{field} = ?")
+                values.append(value)
+            else:
+                where_clauses.append(field)
+                if operator not in ["__isnull", "__notnull"]:
+                    if isinstance(value, list):
+                        values.extend(value)
+                    else:
+                        values.append(value)
 
-        with self.db.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(sql, values)
-            return cursor.fetchall() if not fetch_one else cursor.fetchone()
+        where_clause = " AND ".join(where_clauses)
+        return values, where_clause
 
     def fetch_all(self) -> list[BaseDBModel]:
         """Fetch all results matching the filters."""
         results = self._execute_query()
 
-        if results is None:
+        if not results:
             return []
 
         return [
@@ -92,7 +300,8 @@ class QueryBuilder:
 
     def fetch_first(self) -> BaseDBModel | None:
         """Fetch the first result of the query."""
-        result = self._execute_query(limit=1)
+        self._limit = 1
+        result = self._execute_query()
         if not result:
             return None
         return self.model_class(
@@ -103,9 +312,10 @@ class QueryBuilder:
         )
 
     def fetch_last(self) -> BaseDBModel | None:
-        """Fetch the last result of the query (based on the primary key)."""
-        primary_key = self.model_class.get_primary_key()
-        result = self._execute_query(limit=1, order_by=f"{primary_key} DESC")
+        """Fetch the last result of the query (based on the insertion order)."""
+        self._limit = 1
+        self._order_by = "rowid DESC"
+        result = self._execute_query()
         if not result:
             return None
         return self.model_class(
@@ -117,22 +327,9 @@ class QueryBuilder:
 
     def count(self) -> int:
         """Return the count of records matching the filters."""
-        where_clause = " AND ".join(
-            [f"{field} = ?" for field, _ in self.filters]
-        )
-        sql = f"SELECT COUNT(*) FROM {self.table_name}"  # noqa: S608
-
-        if self.filters:
-            sql += f" WHERE {where_clause}"
-
-        values = [value for _, value in self.filters]
-
-        with self.db.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(sql, values)
-            result = cursor.fetchone()
+        result = self._execute_query(count_only=True)
 
-        return int(result[0]) if result else 0
+        return int(result[0][0]) if result else 0
 
     def exists(self) -> bool:
         """Return True if any record matches the filters."""

sqliter/sqliter.py

@@ -7,9 +7,18 @@ from typing import TYPE_CHECKING, Optional
 
 from typing_extensions import Self
 
+from sqliter.exceptions import (
+    DatabaseConnectionError,
+    RecordDeletionError,
+    RecordFetchError,
+    RecordInsertionError,
+    RecordNotFoundError,
+    RecordUpdateError,
+    TableCreationError,
+)
 from sqliter.query.query import QueryBuilder
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from types import TracebackType
 
     from sqliter.model.model import BaseDBModel
@@ -18,7 +27,7 @@ if TYPE_CHECKING:
 class SqliterDB:
     """Class to manage SQLite database interactions."""
 
-    def __init__(self, db_filename: str, *, auto_commit: bool = False) -> None:
+    def __init__(self, db_filename: str, *, auto_commit: bool = True) -> None:
         """Initialize the class and options."""
         self.db_filename = db_filename
         self.auto_commit = auto_commit
@@ -27,9 +36,24 @@ class SqliterDB:
     def connect(self) -> sqlite3.Connection:
         """Create or return a connection to the SQLite database."""
         if not self.conn:
-            self.conn = sqlite3.connect(self.db_filename)
+            try:
+                self.conn = sqlite3.connect(self.db_filename)
+            except sqlite3.Error as exc:
+                raise DatabaseConnectionError(self.db_filename) from exc
         return self.conn
 
+    def close(self) -> None:
+        """Close the connection to the SQLite database."""
+        if self.conn:
+            self._maybe_commit()
+            self.conn.close()
+            self.conn = None
+
+    def commit(self) -> None:
+        """Commit any pending transactions."""
+        if self.conn:
+            self.conn.commit()
+
     def create_table(self, model_class: type[BaseDBModel]) -> None:
         """Create a table based on the Pydantic model."""
         table_name = model_class.get_table_name()
@@ -43,7 +67,7 @@ class SqliterDB:
         if create_id:
             create_table_sql = f"""
                 CREATE TABLE IF NOT EXISTS {table_name} (
-                    id INTEGER PRIMARY KEY AUTOINCREMENT,
+                    {primary_key} INTEGER PRIMARY KEY AUTOINCREMENT,
                     {fields}
                 )
             """
@@ -55,15 +79,18 @@ class SqliterDB:
                 )
             """
 
-        with self.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(create_table_sql)
-            conn.commit()
+        try:
+            with self.connect() as conn:
+                cursor = conn.cursor()
+                cursor.execute(create_table_sql)
+                conn.commit()
+        except sqlite3.Error as exc:
+            raise TableCreationError(table_name) from exc
 
-    def _maybe_commit(self, conn: sqlite3.Connection) -> None:
+    def _maybe_commit(self) -> None:
         """Commit changes if auto_commit is True."""
-        if self.auto_commit:
-            conn.commit()
+        if self.auto_commit and self.conn:
+            self.conn.commit()
 
     def insert(self, model_instance: BaseDBModel) -> None:
         """Insert a new record into the table defined by the Pydantic model."""
@@ -77,14 +104,17 @@ class SqliterDB:
         )
 
         insert_sql = f"""
-        INSERT OR REPLACE INTO {table_name} ({fields})
+        INSERT INTO {table_name} ({fields})
         VALUES ({placeholders})
     """  # noqa: S608
 
-        with self.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(insert_sql, values)
-            self._maybe_commit(conn)
+        try:
+            with self.connect() as conn:
+                cursor = conn.cursor()
+                cursor.execute(insert_sql, values)
+                self._maybe_commit()
+        except sqlite3.Error as exc:
+            raise RecordInsertionError(table_name) from exc
 
     def get(
         self, model_class: type[BaseDBModel], primary_key_value: str
@@ -99,18 +129,22 @@ class SqliterDB:
             SELECT {fields} FROM {table_name} WHERE {primary_key} = ?
         """  # noqa: S608
 
-        with self.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(select_sql, (primary_key_value,))
-            result = cursor.fetchone()
-
-        if result:
-            result_dict = {
-                field: result[idx]
-                for idx, field in enumerate(model_class.model_fields)
-            }
-            return model_class(**result_dict)
-        return None
+        try:
+            with self.connect() as conn:
+                cursor = conn.cursor()
+                cursor.execute(select_sql, (primary_key_value,))
+                result = cursor.fetchone()
+
+            if result:
+                result_dict = {
+                    field: result[idx]
+                    for idx, field in enumerate(model_class.model_fields)
+                }
+                return model_class(**result_dict)
+        except sqlite3.Error as exc:
+            raise RecordFetchError(table_name) from exc
+        else:
+            return None
 
     def update(self, model_instance: BaseDBModel) -> None:
         """Update an existing record using the Pydantic model."""
@@ -131,13 +165,24 @@ class SqliterDB:
         primary_key_value = getattr(model_instance, primary_key)
 
         update_sql = f"""
-            UPDATE {table_name} SET {fields} WHERE {primary_key} = ?
+            UPDATE {table_name}
+            SET {fields}
+            WHERE {primary_key} = ?
         """  # noqa: S608
 
-        with self.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(update_sql, (*values, primary_key_value))
-            self._maybe_commit(conn)
+        try:
+            with self.connect() as conn:
+                cursor = conn.cursor()
+                cursor.execute(update_sql, (*values, primary_key_value))
+
+                # Check if any rows were updated
+                if cursor.rowcount == 0:
+                    raise RecordNotFoundError(primary_key_value)
+
+                self._maybe_commit()
+
+        except sqlite3.Error as exc:
+            raise RecordUpdateError(table_name) from exc
 
     def delete(
         self, model_class: type[BaseDBModel], primary_key_value: str
@@ -150,10 +195,16 @@ class SqliterDB:
             DELETE FROM {table_name} WHERE {primary_key} = ?
         """  # noqa: S608
 
-        with self.connect() as conn:
-            cursor = conn.cursor()
-            cursor.execute(delete_sql, (primary_key_value,))
-            self._maybe_commit(conn)
+        try:
+            with self.connect() as conn:
+                cursor = conn.cursor()
+                cursor.execute(delete_sql, (primary_key_value,))
+
+                if cursor.rowcount == 0:
+                    raise RecordNotFoundError(primary_key_value)
+                self._maybe_commit()
+        except sqlite3.Error as exc:
+            raise RecordDeletionError(table_name) from exc
 
     def select(self, model_class: type[BaseDBModel]) -> QueryBuilder:
         """Start a query for the given model."""
@@ -173,7 +224,13 @@ class SqliterDB:
     ) -> None:
         """Exit the runtime context and close the connection."""
         if self.conn:
-            if not self.auto_commit:
-                self.conn.commit()
-            self.conn.close()
-            self.conn = None
+            try:
+                if exc_type:
+                    # Roll back the transaction if there was an exception
+                    self.conn.rollback()
+                else:
+                    self.conn.commit()
+            finally:
+                # Close the connection and reset the instance variable
+                self.conn.close()
+                self.conn = None

sqliter_py-0.2.0.dist-info/METADATA

@@ -0,0 +1,351 @@
+Metadata-Version: 2.3
+Name: sqliter-py
+Version: 0.2.0
+Summary: Interact with SQLite databases using Python and Pydantic
+Project-URL: Pull Requests, https://github.com/seapagan/sqliter-py/pulls
+Project-URL: Bug Tracker, https://github.com/seapagan/sqliter-py/issues
+Project-URL: Changelog, https://github.com/seapagan/sqliter-py/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/seapagan/sqliter-py
+Author-email: Grant Ramsay <grant@gnramsay.com>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: pydantic>=2.9.0
+Description-Content-Type: text/markdown
+
+# SQLiter <!-- omit in toc -->
+
+![PyPI - Version](https://img.shields.io/pypi/v/sqliter-py)
+[![Test Suite](https://github.com/seapagan/sqliter-py/actions/workflows/testing.yml/badge.svg)](https://github.com/seapagan/sqliter-py/actions/workflows/testing.yml)
+[![Linting](https://github.com/seapagan/sqliter-py/actions/workflows/linting.yml/badge.svg)](https://github.com/seapagan/sqliter-py/actions/workflows/linting.yml)
+[![Type Checking](https://github.com/seapagan/sqliter-py/actions/workflows/mypy.yml/badge.svg)](https://github.com/seapagan/sqliter-py/actions/workflows/mypy.yml)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqliter-py)
+
+SQLiter is a lightweight Object-Relational Mapping (ORM) library for SQLite
+databases in Python. It provides a simplified interface for interacting with
+SQLite databases using Pydantic models. The only external run-time dependency
+is Pydantic itself.
+
+It does not aim to be a full-fledged ORM like SQLAlchemy, but rather a simple
+and easy-to-use library for basic database operations, especially for small
+projects. It is NOT asynchronous and does not support complex queries (at this
+time).
+
+The ideal use case is more for Python CLI tools that need to store data in a
+database-like format without needing to learn SQL or use a full ORM.
+
+> [!NOTE]
+> This project is still in the early stages of development and is lacking some
+> planned functionality. Please use with caution.
+>
+> See the [TODO](TODO.md) for planned features and improvements.
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Detailed Usage](#detailed-usage)
+  - [Defining Models](#defining-models)
+  - [Database Operations](#database-operations)
+    - [Creating a Connection](#creating-a-connection)
+    - [Creating Tables](#creating-tables)
+    - [Inserting Records](#inserting-records)
+    - [Querying Records](#querying-records)
+    - [Updating Records](#updating-records)
+    - [Deleting Records](#deleting-records)
+    - [Commit your changes](#commit-your-changes)
+    - [Close the Connection](#close-the-connection)
+  - [Transactions](#transactions)
+  - [Filter Options](#filter-options)
+    - [Basic Filters](#basic-filters)
+    - [Null Checks](#null-checks)
+    - [Comparison Operators](#comparison-operators)
+    - [List Operations](#list-operations)
+    - [String Operations (Case-Sensitive)](#string-operations-case-sensitive)
+    - [String Operations (Case-Insensitive)](#string-operations-case-insensitive)
+- [Contributing](#contributing)
+- [License](#license)
+- [Acknowledgements](#acknowledgements)
+
+## Features
+
+- Table creation based on Pydantic models
+- CRUD operations (Create, Read, Update, Delete)
+- Basic query building with filtering, ordering, and pagination
+- Transaction support
+- Custom exceptions for better error handling
+
+## Installation
+
+You can install SQLiter using whichever method you prefer or is compatible with
+your project setup.
+
+With `pip`:
+
+```bash
+pip install sqliter-py
+```
+
+Or `Poetry`:
+
+```bash
+poetry add sqliter-py
+```
+
+Or `uv` which is rapidly becoming my favorite tool for managing projects and
+virtual environments (`uv` is used for developing this project and in the CI):
+
+```bash
+uv add sqliter-py
+```
+
+## Quick Start
+
+Here's a quick example of how to use SQLiter:
+
+```python
+from sqliter import SqliterDB
+from sqliter.model import BaseDBModel
+
+# Define your model
+class User(BaseDBModel):
+    name: str
+    age: int
+
+    class Meta:
+        table_name = "users"
+
+# Create a database connection
+db = SqliterDB("example.db")
+
+# Create the table
+db.create_table(User)
+
+# Insert a record
+user = User(name="John Doe", age=30)
+db.insert(user)
+
+# Query records
+results = db.select(User).filter(name="John Doe").fetch_all()
+for user in results:
+    print(f"User: {user.name}, Age: {user.age}")
+
+# Update a record
+user.age = 31
+db.update(user)
+
+# Delete a record
+db.delete(User, "John Doe")
+```
+
+## Detailed Usage
+
+### Defining Models
+
+Models in SQLiter are based on Pydantic's `BaseModel`. You can define your
+models like this:
+
+```python
+from sqliter.model import BaseDBModel
+
+class User(BaseDBModel):
+    name: str
+    age: int
+    email: str
+
+    class Meta:
+        table_name = "users"
+        primary_key = "name"  # Default is "id"
+        create_id = False  # Set to True to auto-create an ID field
+```
+
+### Database Operations
+
+#### Creating a Connection
+
+```python
+from sqliter import SqliterDB
+
+db = SqliterDB("your_database.db")
+```
+
+The default behavior is to automatically commit changes to the database after
+each operation. If you want to disable this behavior, you can set `auto_commit=False`
+when creating the database connection:
+
+```python
+db = SqliterDB("your_database.db", auto_commit=False)
+```
+
+It is then up to you to manually commit changes using the `commit()` method.
+This can be useful when you want to perform multiple operations in a single
+transaction without the overhead of committing after each operation.
+
+#### Creating Tables
+
+```python
+db.create_table(User)
+```
+
+#### Inserting Records
+
+```python
+user = User(name="Jane Doe", age=25, email="jane@example.com")
+db.insert(user)
+```
+
+#### Querying Records
+
+```python
+# Fetch all users
+all_users = db.select(User).fetch_all()
+
+# Filter users
+young_users = db.select(User).filter(age=25).fetch_all()
+
+# Order users
+ordered_users = db.select(User).order("age", direction="DESC").fetch_all()
+
+# Limit and offset
+paginated_users = db.select(User).limit(10).offset(20).fetch_all()
+```
+
+See below for more advanced filtering options.
+
+#### Updating Records
+
+```python
+user.age = 26
+db.update(user)
+```
+
+#### Deleting Records
+
+```python
+db.delete(User, "Jane Doe")
+```
+
+#### Commit your changes
+
+By default, SQLiter will automatically commit changes to the database after each
+operation. If you want to disable this behavior, you can set `auto_commit=False`
+when creating the database connection:
+
+```python
+db = SqliterDB("your_database.db", auto_commit=False)
+```
+
+You can then manually commit changes using the `commit()` method:
+
+```python
+db.commit()
+```
+
+#### Close the Connection
+
+When you're done with the database connection, you should close it to release
+resources:
+
+```python
+db.close()
+```
+
+Note that closing the connection will also commit any pending changes, unless
+`auto_commit` is set to `False`.
+
+### Transactions
+
+SQLiter supports transactions using Python's context manager:
+
+```python
+with db:
+    db.insert(User(name="Alice", age=30, email="alice@example.com"))
+    db.insert(User(name="Bob", age=35, email="bob@example.com"))
+    # If an exception occurs, the transaction will be rolled back
+```
+
+> [!WARNING]
+> Using the context manager will automatically commit the transaction
+> at the end (unless an exception occurs), regardless of the `auto_commit`
+> setting.
+>
+> the 'close()' method will also be called when the context manager exits, so you
+> do not need to call it manually.
+
+### Filter Options
+
+The `filter()` method in SQLiter supports various filter options to query records.
+
+#### Basic Filters
+
+- `__eq`: Equal to (default if no operator is specified)
+  - Example: `name="John"` or `name__eq="John"`
+
+#### Null Checks
+
+- `__isnull`: Is NULL
+  - Example: `email__isnull=True`
+- `__notnull`: Is NOT NULL
+  - Example: `email__notnull=True`
+
+#### Comparison Operators
+
+- `__lt`: Less than
+  - Example: `age__lt=30`
+- `__lte`: Less than or equal to
+  - Example: `age__lte=30`
+- `__gt`: Greater than
+  - Example: `age__gt=30`
+- `__gte`: Greater than or equal to
+  - Example: `age__gte=30`
+- `__ne`: Not equal to
+  - Example: `status__ne="inactive"`
+
+#### List Operations
+
+- `__in`: In a list of values
+  - Example: `status__in=["active", "pending"]`
+- `__not_in`: Not in a list of values
+  - Example: `category__not_in=["archived", "deleted"]`
+
+#### String Operations (Case-Sensitive)
+
+- `__startswith`: Starts with
+  - Example: `name__startswith="A"`
+- `__endswith`: Ends with
+  - Example: `email__endswith=".com"`
+- `__contains`: Contains
+  - Example: `description__contains="important"`
+
+#### String Operations (Case-Insensitive)
+
+- `__istartswith`: Starts with (case-insensitive)
+  - Example: `name__istartswith="a"`
+- `__iendswith`: Ends with (case-insensitive)
+  - Example: `email__iendswith=".COM"`
+- `__icontains`: Contains (case-insensitive)
+  - Example: `description__icontains="IMPORTANT"`
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Acknowledgements
+
+SQLiter was initially developed as an experiment to see how helpful ChatGPT and
+Claud AI can be to speed up the development process. The initial version of the
+code was generated by ChatGPT, with subsequent manual/AI refinements and
+improvements.

sqliter_py-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+sqliter/__init__.py,sha256=L8R0uvCbbbACwaI5xtd3khtvpNhlPRgHJAaYZvqjzig,134
+sqliter/constants.py,sha256=QEUC6kPkwYItgFRUmV6qfK9YV1PcUyUoBwj34yhAyik,441
+sqliter/exceptions.py,sha256=RP1T67PkJMOgkT7yIjES1xil832_UmuAeABtNiv-RKE,3756
+sqliter/sqliter.py,sha256=1MOa763OQdwkiAHHAitEKox5O9EV0FVMbMWC7pqyk9U,7823
+sqliter/model/__init__.py,sha256=Ovpkbyx2-T6Oee0qFNgUBBc2M0uwK-cdG0pigG3mkd8,179
+sqliter/model/model.py,sha256=t1w38om37gma1gRk01Z_9II0h4g-l734ijN_8M1SYoY,1247
+sqliter/query/__init__.py,sha256=BluNMJpuoo2PsYN-bL7fXlEc02O_8LgOMsvCmyv04ao,125
+sqliter/query/query.py,sha256=dRW-Y7X3qH4HrTw-oFbomnl4Kz7WOsImIfoKXZqkMKQ,11648
+sqliter_py-0.2.0.dist-info/METADATA,sha256=OBYavQg-H3HipYh_mVkaJ4cL_EUpzqPk1MtypWUpwlg,9880
+sqliter_py-0.2.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+sqliter_py-0.2.0.dist-info/RECORD,,

sqliter_py-0.1.0.dist-info/METADATA

@@ -1,30 +0,0 @@
-Metadata-Version: 2.3
-Name: sqliter-py
-Version: 0.1.0
-Summary: Interact with SQLite databases using Python and Pydantic
-Project-URL: Pull Requests, https://github.com/seapagan/sqliter-py/pulls
-Project-URL: Bug Tracker, https://github.com/seapagan/sqliter-py/issues
-Project-URL: Repository, https://github.com/seapagan/sqliter-py
-Author-email: Grant Ramsay <grant@gnramsay.com>
-License-Expression: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-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: Topic :: Software Development
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
-Requires-Dist: pydantic>=2.9.0
-Description-Content-Type: text/markdown
-
-# SQLiter
-
-An SQLite wrapper in Python using Pydantic and written primarily using ChatGPT,
-as an experiment in how viable it is to write working code using a LLM.
-
-The code was then cleaned up, typed and linted by hand.

sqliter_py-0.1.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-sqliter/__init__.py,sha256=L8R0uvCbbbACwaI5xtd3khtvpNhlPRgHJAaYZvqjzig,134
-sqliter/sqliter.py,sha256=FxWtYnjnfM2Tp1lc1b1AfrGia-G0IdSopZ2bSa-lPuo,5944
-sqliter/model/__init__.py,sha256=Ovpkbyx2-T6Oee0qFNgUBBc2M0uwK-cdG0pigG3mkd8,179
-sqliter/model/model.py,sha256=t1w38om37gma1gRk01Z_9II0h4g-l734ijN_8M1SYoY,1247
-sqliter/query/__init__.py,sha256=BluNMJpuoo2PsYN-bL7fXlEc02O_8LgOMsvCmyv04ao,125
-sqliter/query/query.py,sha256=8wV5GJwQVFesnW60Qe9XCiOwEZI3Wvk-8WNM0ANsT_M,4442
-sqliter_py-0.1.0.dist-info/METADATA,sha256=R_IogiSpgnGC54Mftva2w5EIa-JnGH-R8NuE5_LDhRo,1267
-sqliter_py-0.1.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sqliter_py-0.1.0.dist-info/RECORD,,