sqliter-py 0.3.0__tar.gz → 0.4.0__tar.gz

{sqliter_py-0.3.0 → sqliter_py-0.4.0}/.gitignore

@@ -65,6 +65,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.lcov
 *.cover
 *.py,cover
 .hypothesis/

sqliter_py-0.4.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.3
+Name: sqliter-py
+Version: 0.4.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
+License-File: LICENSE.txt
+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
+Provides-Extra: extras
+Requires-Dist: inflect==7.0.0; extra == 'extras'
+Description-Content-Type: text/markdown
+
+# SQLiter <!-- omit in toc -->
+
+[![PyPI version](https://badge.fury.io/py/sqliter-py.svg)](https://badge.fury.io/py/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.
+
+Full documentation is available on the [Documentation
+Website](https://sqliter.grantramsay.dev)
+
+> [!CAUTION]
+> This project is still in the early stages of development and is lacking some
+> planned functionality. Please use with caution.
+>
+> Also, structures like `list`, `dict`, `set` etc are not supported **at this
+> time** as field types, since SQLite does not have a native column type for
+> these. I will look at implementing these in the future, probably by
+> serializing them to JSON or pickling them and storing in a text field. For
+> now, you can actually do this manually when creating your Model (use `TEXT` or
+> `BLOB` fields), then serialize before saving after and retrieving data.
+>
+> See the [TODO](TODO.md) for planned features and improvements.
+
+- [Features](#features)
+- [Installation](#installation)
+  - [Optional Dependencies](#optional-dependencies)
+- [Quick Start](#quick-start)
+- [Contributing](#contributing)
+- [License](#license)
+
+## 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
+- Full type hinting and type checking
+- No external dependencies other than Pydantic
+- Full test coverage
+- Can optionally output the raw SQL queries being executed for debugging
+  purposes.
+
+## Installation
+
+You can install SQLiter using whichever method you prefer or is compatible with
+your project setup.
+
+With `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
+```
+
+With `pip`:
+
+```bash
+pip install sqliter-py
+```
+
+Or with `Poetry`:
+
+```bash
+poetry add sqliter-py
+```
+
+### Optional Dependencies
+
+Currently by default, the only external dependency is Pydantic. However, there
+are some optional dependencies that can be installed to enable additional
+features:
+
+- `inflect`: For pluralizing table names (if not specified). This just offers a
+  more-advanced pluralization than the default method used. In most cases you
+  will not need this.
+
+See [Installing Optional
+Dependencies](https://sqliter.grantramsay.dev/installation#optional-dependencies)
+for more information.
+
+## 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
+
+# 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")
+```
+
+See the [Usage](https://sqliter.grantramsay.dev/usage) section of the documentation
+for more detailed information on how to use SQLiter, and advanced features.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+See the [CONTRIBUTING](CONTRIBUTING.md) guide for more information.
+
+Please note that this project is released with a Contributor Code of Conduct,
+which you can read in the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.
+
+## License
+
+This project is licensed under the MIT License.
+
+```pre
+Copyright (c) 2024 Grant Ramsay
+
+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.
+```

sqliter_py-0.4.0/README.md

@@ -0,0 +1,168 @@
+# SQLiter <!-- omit in toc -->
+
+[![PyPI version](https://badge.fury.io/py/sqliter-py.svg)](https://badge.fury.io/py/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.
+
+Full documentation is available on the [Documentation
+Website](https://sqliter.grantramsay.dev)
+
+> [!CAUTION]
+> This project is still in the early stages of development and is lacking some
+> planned functionality. Please use with caution.
+>
+> Also, structures like `list`, `dict`, `set` etc are not supported **at this
+> time** as field types, since SQLite does not have a native column type for
+> these. I will look at implementing these in the future, probably by
+> serializing them to JSON or pickling them and storing in a text field. For
+> now, you can actually do this manually when creating your Model (use `TEXT` or
+> `BLOB` fields), then serialize before saving after and retrieving data.
+>
+> See the [TODO](TODO.md) for planned features and improvements.
+
+- [Features](#features)
+- [Installation](#installation)
+  - [Optional Dependencies](#optional-dependencies)
+- [Quick Start](#quick-start)
+- [Contributing](#contributing)
+- [License](#license)
+
+## 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
+- Full type hinting and type checking
+- No external dependencies other than Pydantic
+- Full test coverage
+- Can optionally output the raw SQL queries being executed for debugging
+  purposes.
+
+## Installation
+
+You can install SQLiter using whichever method you prefer or is compatible with
+your project setup.
+
+With `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
+```
+
+With `pip`:
+
+```bash
+pip install sqliter-py
+```
+
+Or with `Poetry`:
+
+```bash
+poetry add sqliter-py
+```
+
+### Optional Dependencies
+
+Currently by default, the only external dependency is Pydantic. However, there
+are some optional dependencies that can be installed to enable additional
+features:
+
+- `inflect`: For pluralizing table names (if not specified). This just offers a
+  more-advanced pluralization than the default method used. In most cases you
+  will not need this.
+
+See [Installing Optional
+Dependencies](https://sqliter.grantramsay.dev/installation#optional-dependencies)
+for more information.
+
+## 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
+
+# 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")
+```
+
+See the [Usage](https://sqliter.grantramsay.dev/usage) section of the documentation
+for more detailed information on how to use SQLiter, and advanced features.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+See the [CONTRIBUTING](CONTRIBUTING.md) guide for more information.
+
+Please note that this project is released with a Contributor Code of Conduct,
+which you can read in the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.
+
+## License
+
+This project is licensed under the MIT License.
+
+```pre
+Copyright (c) 2024 Grant Ramsay
+
+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.
+```

{sqliter_py-0.3.0 → sqliter_py-0.4.0}/pyproject.toml

@@ -1,6 +1,9 @@
+# Configuration file for the SQLiter project.
+# This file defines project metadata, dependencies, and development tools.
+
 [project]
 name = "sqliter-py"
-version = "0.3.0"
+version = "0.4.0"
 description = "Interact with SQLite databases using Python and Pydantic"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -58,6 +61,11 @@ dev-dependencies = [
   "poethepoet>=0.28.0",
   "github-changelog-md>=0.9.5",
   "pre-commit>=3.8.0",
+  "mkdocs>=1.6.1",
+  "mkdocs-material>=9.5.36",
+  "pygments>=2.18.0",
+  "mkdocs-minify-plugin>=0.8.0",
+  "mdx-truly-sane-lists>=1.3",
 ]
 
 [tool.poe.tasks]
@@ -66,19 +74,28 @@ pre.help = "Run pre-commit checks"
 
 mypy.cmd = "mypy . --strict"
 mypy.help = "Run mypy checks"
-format.help = "Format code with Ruff"
 format.cmd = "ruff format ."
-ruff.help = "Run Ruff checks"
+format.help = "Format code with Ruff"
 ruff.cmd = "ruff check --output-format=concise ."
+ruff.help = "Run Ruff checks"
 
-test.help = "Run tests using Pytest"
 test.cmd = "pytest"
+test.help = "Run tests using Pytest"
 "test:watch".cmd = "ptw . --now --clear"
 "test:watch".help = "Run tests using Pytest in watch mode"
 
 changelog.cmd = "github-changelog-md"
 changelog.help = "Generate a changelog"
 
+"docs:publish".cmd = "mkdocs gh-deploy"
+"docs:publish".help = "Publish documentation to GitHub Pages"
+"docs:build".cmd = "mkdocs build"
+"docs:build".help = "Build documentation locally to './site' folder"
+"docs:serve".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md"
+"docs:serve".help = "Serve documentation locally"
+"docs:serve:all".cmd = "mkdocs serve -w TODO.md -w CHANGELOG.md -w CONTRIBUTING.md -a 0.0.0.0:9000"
+"docs:serve:all".help = "Serve documentation locally on all interfaces"
+
 [tool.ruff]
 line-length = 80
 lint.select = ["ALL"] # we are being very strict!
@@ -102,6 +119,9 @@ target-version = "py39" # minimum python version supported
 indent-style = "space"
 quote-style = "double"
 
+[tool.ruff.lint.pylint]
+max-args = 6
+
 [tool.ruff.lint.pep8-naming]
 classmethod-decorators = ["pydantic.validator", "pydantic.root_validator"]
 
@@ -125,17 +145,27 @@ keep-runtime-typing = true
 
 [tool.mypy]
 python_version = "3.9"
+exclude = ["docs"]
 
 [[tool.mypy.overrides]]
 disable_error_code = ["method-assign", "no-untyped-def", "attr-defined"]
 module = "tests.*"
 
 [tool.pytest.ini_options]
-addopts = ["--cov", "--cov-report", "term-missing", "--cov-report", "html"]
+addopts = [
+  "--cov",
+  "--cov-report",
+  "term-missing",
+  "--cov-report",
+  "html",
+  "--cov-report",
+  "lcov",
+]
 filterwarnings = [
   "ignore:'direction' argument is deprecated:DeprecationWarning",
 ]
 mock_use_standalone_module = true
+markers = []
 
 [tool.coverage.run]
 source = ["sqliter"]

sqliter_py-0.4.0/sqliter/__init__.py

@@ -0,0 +1,9 @@
+"""SQLiter: A lightweight ORM-like library for SQLite databases in Python.
+
+This module provides the main SqliterDB class for interacting with
+SQLite databases using Pydantic models.
+"""
+
+from .sqliter import SqliterDB
+
+__all__ = ["SqliterDB"]

sqliter_py-0.4.0/sqliter/constants.py

@@ -0,0 +1,37 @@
+"""Constant values and mappings used throughout SQLiter.
+
+This module defines constant dictionaries that map SQLiter-specific
+concepts to their SQLite equivalents. It includes mappings for query
+operators and data types, which are crucial for translating between
+Pydantic models and SQLite database operations.
+"""
+
+# A dictionary mapping SQLiter filter operators to their corresponding SQL
+# operators.
+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",
+}
+
+# A dictionary mapping Python types to their corresponding SQLite column types.
+SQLITE_TYPE_MAPPING = {
+    int: "INTEGER",
+    float: "REAL",
+    str: "TEXT",
+    bool: "INTEGER",  # SQLite stores booleans as integers (0 or 1)
+    bytes: "BLOB",
+}

{sqliter_py-0.3.0 → sqliter_py-0.4.0}/sqliter/exceptions.py

@@ -1,4 +1,11 @@
-"""Define custom exceptions for the sqliter package."""
+"""Custom exception classes for SQLiter error handling.
+
+This module defines a hierarchy of exception classes specific to
+SQLiter operations. These exceptions provide detailed error information
+for various scenarios such as connection issues, invalid queries,
+and CRUD operation failures, enabling more precise error handling
+in applications using SQLiter.
+"""
 
 import os
 import sys
@@ -6,7 +13,15 @@ import traceback
 
 
 class SqliterError(Exception):
-    """Base class for all exceptions raised by the sqliter package."""
+    """Base exception class for all SQLiter-specific errors.
+
+    This class serves as the parent for all custom exceptions in SQLiter,
+    providing a consistent interface and message formatting.
+
+    Attributes:
+        message_template (str): A template string for the error message.
+        original_exception (Exception): The original exception that was caught.
+    """
 
     message_template: str = "An error occurred in the SQLiter package."
 
@@ -59,13 +74,13 @@ class SqliterError(Exception):
 
 
 class DatabaseConnectionError(SqliterError):
-    """Raised when the SQLite database connection fails."""
+    """Exception raised when a database connection cannot be established."""
 
     message_template = "Failed to connect to the database: '{}'"
 
 
 class InvalidOffsetError(SqliterError):
-    """Raised when an invalid offset value (0 or negative) is used."""
+    """Exception raised when an invalid offset value is provided."""
 
     message_template = (
         "Invalid offset value: '{}'. Offset must be a positive integer."
@@ -73,48 +88,60 @@ class InvalidOffsetError(SqliterError):
 
 
 class InvalidOrderError(SqliterError):
-    """Raised when an invalid order value is used."""
+    """Exception raised when an invalid order specification is provided."""
 
     message_template = "Invalid order value - {}"
 
 
 class TableCreationError(SqliterError):
-    """Raised when a table cannot be created in the database."""
+    """Exception 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."""
+    """Exception raised when a record cannot be inserted into the database."""
 
     message_template = "Failed to insert record into table: '{}'"
 
 
 class RecordUpdateError(SqliterError):
-    """Raised when an error occurs during record update."""
+    """Exception raised when a record cannot be updated in the database."""
 
     message_template = "Failed to update record in table: '{}'"
 
 
 class RecordNotFoundError(SqliterError):
-    """Raised when a record with the specified primary key is not found."""
+    """Exception raised when a requested record is not found in the database."""
 
     message_template = "Failed to find a record for key '{}' "
 
 
 class RecordFetchError(SqliterError):
-    """Raised when an error occurs during record fetching."""
+    """Exception raised on an error fetching records from the database."""
 
     message_template = "Failed to fetch record from table: '{}'"
 
 
 class RecordDeletionError(SqliterError):
-    """Raised when an error occurs during record deletion."""
+    """Exception raised when a record cannot be deleted from the database."""
 
     message_template = "Failed to delete record from table: '{}'"
 
 
 class InvalidFilterError(SqliterError):
-    """Raised when an invalid filter field is used in a query."""
+    """Exception raised when an invalid filter is applied to a query."""
 
     message_template = "Failed to apply filter: invalid field '{}'"
+
+
+class TableDeletionError(SqliterError):
+    """Raised when a table cannot be deleted from the database."""
+
+    message_template = "Failed to delete the table: '{}'"
+
+
+class SqlExecutionError(SqliterError):
+    """Raised when an SQL execution fails."""
+
+    message_template = "Failed to execute SQL: '{}'"

sqliter_py-0.4.0/sqliter/helpers.py

@@ -0,0 +1,35 @@
+"""Utility functions for SQLiter internal operations.
+
+This module provides helper functions used across the SQLiter library,
+primarily for type inference and mapping between Python and SQLite
+data types. These utilities support the core functionality of model
+to database schema translation.
+"""
+
+from typing import Union
+
+from sqliter.constants import SQLITE_TYPE_MAPPING
+
+
+def infer_sqlite_type(field_type: Union[type, None]) -> str:
+    """Infer the SQLite column type based on the Python type.
+
+    This function maps Python types to their corresponding SQLite column
+    types. It's used when creating database tables to ensure that the
+    correct SQLite types are used for each field.
+
+    Args:
+        field_type: The Python type of the field, or None.
+
+    Returns:
+        A string representing the corresponding SQLite column type.
+
+    Note:
+        If the input type is None or not recognized, it defaults to 'TEXT'.
+    """
+    # If field_type is None, default to TEXT
+    if field_type is None:
+        return "TEXT"
+
+    # Map the simplified type to an SQLite type
+    return SQLITE_TYPE_MAPPING.get(field_type, "TEXT")

sqliter_py-0.4.0/sqliter/model/__init__.py

@@ -0,0 +1,9 @@
+"""This module provides the base model class for SQLiter database models.
+
+It exports the BaseDBModel class, which is used to define database
+models in SQLiter applications.
+"""
+
+from .model import BaseDBModel
+
+__all__ = ["BaseDBModel"]