sqliter-py 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

sqliter_py-0.1.1.dist-info/METADATA

@@ -1,204 +0,0 @@
-Metadata-Version: 2.3
-Name: sqliter-py
-Version: 0.1.1
-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
-
-<!-- ![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.
-
-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
-
-- 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 pip:
-
-```bash
-pip install 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", auto_commit=True)
-
-# 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", auto_commit=True)
-```
-
-#### 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 DESC").fetch_all()
-
-# Limit and offset
-paginated_users = db.select(User).limit(10).offset(20).fetch_all()
-```
-
-Note: The filtering in SQLiter is basic and supports exact matches. Complex
-queries like `age__lt` are not supported in the current implementation.
-
-#### Updating Records
-
-```python
-user.age = 26
-db.update(user)
-```
-
-#### Deleting Records
-
-```python
-db.delete(User, "Jane Doe")
-```
-
-### 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
-```
-
-## 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 using ChatGPT, with subsequent
-manual refinements and improvements.

sqliter_py-0.1.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-sqliter/__init__.py,sha256=L8R0uvCbbbACwaI5xtd3khtvpNhlPRgHJAaYZvqjzig,134
-sqliter/exceptions.py,sha256=5NO9DwHMVKrDZP908G63J5-ANBJDCwbBkXL7h_Bit2Q,3610
-sqliter/sqliter.py,sha256=R69oNusPEg0Q_zRPFetS9VUUCT5pjatXnUr3Tv6yzjE,7494
-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=BRKCdMBOlbcIU5CUxRyKBF4aFT2AboUPu7UwbJ1s5hs,5793
-sqliter_py-0.1.1.dist-info/METADATA,sha256=ehe8KZXc08ftvn2i6FGiw3Qe8jK6QsqApDoDQm9p0XE,5477
-sqliter_py-0.1.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sqliter_py-0.1.1.dist-info/RECORD,,