sqliter-py 0.9.0__tar.gz

sqliter_py-0.9.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: sqliter-py
+Version: 0.9.0
+Summary: Interact with SQLite databases using Python and Pydantic
+Author: Grant Ramsay
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: pydantic==2.11.5
+Requires-Dist: inflect==7.0.0 ; extra == 'extras'
+Requires-Python: >=3.9
+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: Homepage, http://sqliter.grantramsay.dev
+Project-URL: Pull Requests, https://github.com/seapagan/sqliter-py/pulls
+Project-URL: Repository, https://github.com/seapagan/sqliter-py
+Provides-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 [Website](https://sqliter.grantramsay.dev)
+
+> [!CAUTION]
+>
+> Currently NOT compatible with Python 3.14 (I need to refactor some code d/t
+> changes in the latest Pydantic versions, this is a priority.)
+>
+> This project is still in the early stages of development and is lacking some
+> planned functionality. Please use with caution - Classes and methods may
+> change until a stable release is made. I'll try to keep this to an absolute
+> minimum and the releases and documentation will be very clear about any
+> breaking changes.
+>
+> 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
+- Supports `date` and `datetime` fields
+- Support for complex data types (`list`, `dict`, `set`, `tuple`) stored as
+  BLOBs
+- Automatic primary key generation
+- User defined indexes on any field
+- Set any field as UNIQUE
+- CRUD operations (Create, Read, Update, Delete)
+- Chained Query building with filtering, ordering, and pagination
+- Transaction support
+- Custom exceptions for better error handling
+- Full type hinting and type checking
+- Detailed documentation and examples
+- 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 `Poetry`:
+
+```bash
+poetry add sqliter-py
+```
+
+Or with `pip`:
+
+```bash
+pip install 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 the auto-generated table names (if not explicitly
+  set in the Model) 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)
+new_user = 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
+new_user.age = 31
+db.update(new_user)
+
+# Delete a record by primary key
+db.delete(User, new_user.pk)
+
+# Delete all records returned from a query:
+delete_count = db.select(User).filter(age__gt=30).delete()
+```
+
+See the [Guide](https://sqliter.grantramsay.dev/guide/guide/) 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-2025 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.9.0/README.md

@@ -0,0 +1,178 @@
+# 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 [Website](https://sqliter.grantramsay.dev)
+
+> [!CAUTION]
+>
+> Currently NOT compatible with Python 3.14 (I need to refactor some code d/t
+> changes in the latest Pydantic versions, this is a priority.)
+>
+> This project is still in the early stages of development and is lacking some
+> planned functionality. Please use with caution - Classes and methods may
+> change until a stable release is made. I'll try to keep this to an absolute
+> minimum and the releases and documentation will be very clear about any
+> breaking changes.
+>
+> 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
+- Supports `date` and `datetime` fields
+- Support for complex data types (`list`, `dict`, `set`, `tuple`) stored as
+  BLOBs
+- Automatic primary key generation
+- User defined indexes on any field
+- Set any field as UNIQUE
+- CRUD operations (Create, Read, Update, Delete)
+- Chained Query building with filtering, ordering, and pagination
+- Transaction support
+- Custom exceptions for better error handling
+- Full type hinting and type checking
+- Detailed documentation and examples
+- 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 `Poetry`:
+
+```bash
+poetry add sqliter-py
+```
+
+Or with `pip`:
+
+```bash
+pip install 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 the auto-generated table names (if not explicitly
+  set in the Model) 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)
+new_user = 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
+new_user.age = 31
+db.update(new_user)
+
+# Delete a record by primary key
+db.delete(User, new_user.pk)
+
+# Delete all records returned from a query:
+delete_count = db.select(User).filter(age__gt=30).delete()
+```
+
+See the [Guide](https://sqliter.grantramsay.dev/guide/guide/) 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-2025 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.9.0/pyproject.toml

@@ -0,0 +1,172 @@
+# Configuration file for the SQLiter project.
+# This file defines project metadata, dependencies, and development tools.
+
+[project]
+name = "sqliter-py"
+version = "0.9.0"
+description = "Interact with SQLite databases using Python and Pydantic"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [{ name = "Grant Ramsay", email = "grant@gnramsay.com" }]
+dependencies = ["pydantic==2.11.5"]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Database :: Front-Ends",
+  "Topic :: Software Development",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.optional-dependencies]
+extras = ["inflect==7.0.0"]
+
+[project.urls]
+"Homepage" = "http://sqliter.grantramsay.dev"
+"Pull Requests" = "https://github.com/seapagan/sqliter-py/pulls"
+"Bug Tracker" = "https://github.com/seapagan/sqliter-py/issues"
+"Changelog" = "https://github.com/seapagan/sqliter-py/blob/main/CHANGELOG.md"
+"Repository" = "https://github.com/seapagan/sqliter-py"
+
+[build-system]
+requires = ["uv_build>=0.9.9,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "sqliter"
+module-root = ""
+
+[dependency-groups]
+dev = [
+  "mock>=5.1.0",
+  "mypy>=1.11.2",
+  "pytest>=8.3.2",
+  "pytest-mock>=3.14.0",
+  "ruff>=0.6.4",
+  "pytest-sugar>=1.0.0",
+  "pytest-reverse>=1.7.0",
+  "pytest-randomly>=3.15.0",
+  "pytest-cov>=5.0.0",
+  "pytest-watcher>=0.4.3",
+  "pytest-clarity>=1.0.1",
+  "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]
+pre.cmd = "pre-commit run --all-files"
+pre.help = "Run pre-commit checks"
+
+mypy.cmd = "mypy . --strict"
+mypy.help = "Run mypy checks"
+format.cmd = "ruff format ."
+format.help = "Format code with Ruff"
+ruff.cmd = "ruff check --output-format=concise ."
+ruff.help = "Run Ruff checks"
+
+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!
+lint.ignore = [
+  "PGH003",
+  "FBT002",
+  "FBT003",
+  "B006",
+  "S301",   # in this library we use 'pickle' for saving and loading list etc
+] # These rules are too strict even for us 😝
+lint.extend-ignore = [
+  "COM812",
+  "ISC001",
+] # these are ignored for ruff formatting
+
+src = ["sqliter"]
+target-version = "py39" # minimum python version supported
+
+[tool.ruff.format]
+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"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/**/*.py" = [
+  "S101",    # we can (and MUST!) use 'assert' in test files.
+  "ANN001",  # annotations for fixtures are sometimes a pain for test files
+  "ARG00",   # test fixtures often are not directly used
+  "PLR2004", # magic numbers are often used in test files
+  "SLF001",  # sometimes we need to test private methods
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["sqliter"]
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.mypy]
+plugins = ["pydantic.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",
+  "--cov-report",
+  "lcov",
+]
+filterwarnings = [
+  "ignore:'direction' argument is deprecated:DeprecationWarning",
+]
+mock_use_standalone_module = true
+markers = []
+
+[tool.coverage.run]
+source = ["sqliter"]
+omit = ["*/tests/*"]

sqliter_py-0.9.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.9.0/sqliter/constants.py

@@ -0,0 +1,45 @@
+"""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.
+"""
+
+import datetime
+
+# 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",
+    datetime.datetime: "INTEGER",  # Store as Unix timestamp
+    datetime.date: "INTEGER",  # Store as Unix timestamp
+    list: "BLOB",
+    dict: "BLOB",
+    set: "BLOB",
+    tuple: "BLOB",
+}