sqlengine-lite 2.1.0__py3-none-any.whl

sqlengine/__init__.py

@@ -0,0 +1,7 @@
+from .utils import sqlgen, types
+from .utils.types import Schema
+from .sqltable import SqlTableMixin
+
+__author__  = "suffermuffin"
+
+__all__ = ["types", "sqlgen", "Schema", "SqlTableMixin"]

sqlengine/schema.py

@@ -0,0 +1,114 @@
+import os
+import sqlite3
+from typing import overload
+
+from .sqltable import SqlTableMixin
+from .utils.types import Schema
+
+
+def get_database_tablenames(database : str, cursor : sqlite3.Cursor | None = None) -> list[str]:
+    """ Returns all table names of provided `database` path """
+
+    query = (
+        "SELECT name FROM sqlite_schema WHERE "
+        "type = 'table' AND name NOT LIKE 'sqlite_%';"
+    )
+
+    if cursor:
+        cursor.execute(query)
+        names_raw = cursor.fetchall()
+
+    else:
+        with sqlite3.connect(database) as conn:
+            cursor = conn.cursor()
+            cursor.execute(query)
+            names_raw = cursor.fetchall()
+    
+    return [name[0] for name in names_raw if name[0] is not None]
+        
+
+def get_table_schema(database : str, tablename : str, cursor : sqlite3.Cursor | None = None) -> Schema | None:
+    """ Constructs `Schema` from provided `database` and `tablename` if this table exists """
+    
+    query = f"PRAGMA table_info({tablename});"
+
+    if cursor:
+        cursor.execute(query)
+        column_types = cursor.fetchall()
+    
+    else:
+        with sqlite3.connect(database) as conn:
+            cur = conn.cursor()
+            cur.execute(query)
+            column_types = cur.fetchall()
+    
+    if not column_types:
+        return None
+
+    columns = [it[1] for it in column_types]
+    types   = [it[2] for it in column_types]
+    primary = [it[1] for it in column_types if it[-1] > 0]
+
+    return Schema(tablename=tablename, columns=columns, types=types, primary=primary)
+
+
+def get_database_schemas(database : str) -> list[Schema]:
+    """ Reads provided `database` path and outputs gathered schemas of tables inside it """
+
+    if not os.path.exists(database):
+        raise FileNotFoundError(f"File not exists: {database}")
+    
+    with sqlite3.connect(database) as conn:
+        cursor = conn.cursor()
+        names  = get_database_tablenames(database, cursor)
+        
+        schemas : list[Schema] = []
+        
+        for tablename in names:
+            schema = get_table_schema(database, tablename, cursor)
+            
+            if schema:
+                schemas.append(schema)
+
+    return schemas
+
+
+def table_from_schema(database : str, schema : Schema, **kwargs) -> SqlTableMixin:
+    """ Dynamically builds class from provided schema """
+    
+    new_class = type(
+        schema["tablename"],
+        (SqlTableMixin,),
+        {
+            "__tablename__" : schema["tablename"],
+            "__columns__"   : schema["columns"],
+            "__types__"     : schema["types"],
+            "__primary__"   : schema["primary"],
+        }
+    )
+    return new_class(database, **kwargs)
+
+
+@overload
+def table_from_database(database : str, tablename : str, **kwargs) -> SqlTableMixin: ...
+@overload
+def table_from_database(database : str, tablename : None = None, **kwargs) -> list[SqlTableMixin]: ...
+
+def table_from_database(database : str, tablename : str | None = None, **kwargs) -> list[SqlTableMixin] | SqlTableMixin:
+    """ Dynamically builds table class(es) from provided database """
+    
+    schemas = get_database_schemas(database)
+    
+    if len(schemas) < 1:
+        raise sqlite3.DatabaseError(f"No schemas in {database}")
+    
+    if not tablename:
+        return [table_from_schema(database, schema, **kwargs) for schema in schemas]
+    
+    schema_map = {schema["tablename"] : schema for schema in schemas}
+    target_schema = schema_map.get(tablename, None)
+    
+    if not target_schema:
+        raise sqlite3.DatabaseError(f"No tablename `{tablename}` in {database}. Available tables: {list(schema_map.keys())}")
+    
+    return table_from_schema(database, target_schema, **kwargs)

sqlengine/sqltable.py

@@ -0,0 +1,593 @@
+import logging
+import os
+import sqlite3
+
+from contextlib import contextmanager
+from typing     import Sequence, Literal, overload
+
+from .utils            import sqlgen as sql
+from .utils.statements import Select, Update, Delete
+from .utils.repr       import to_html
+
+from .utils.types import SqlRow, SqlValue, SqlType, Schema
+from .utils.types import register_type, is_custom_type, pytype_to_sqltype
+
+logger = logging.getLogger("sqlengine")
+logger.setLevel(os.getenv("SQL_ENGINE_LOG_LEVEL", "WARNING").upper())
+
+
+class SqlTableMixin:
+    """
+    Lightweight wrapper for SQLite3 tables
+    
+    Args:
+        database (str): database filename to connect to. If it not exists - will create new one first.
+            If `":memory:"` is passed, then database will be created in memory and you will have to
+            create table manually with `create_table()` method inside `transaction()` block.
+        force_drop (bool): If `True` - will drop existing table.
+        **connection_params (dict): Params to create connection with. 
+            Reference: https://docs.python.org/3/library/sqlite3.html#sqlite3.connect
+
+    Attributes:
+        __tablename__ (Optional[str]): Name of the table that will be used in queries. 
+            If omitted in inherited class declaration, then it will take the class name.
+        __columns__ (list[str]): Colum names of the table
+        __types__ (list[SqlType | str]): Colum types of the table
+        __primary__ (list[str]): List of primary keys
+
+    Examples:
+        >>> class Employees(SqlTableMixin):
+        >>>     __columns__   = ["ID", "name", "surname", "salary", "position"]
+        >>>     __types__     = [int, str, str, float, "TEXT NOT NULL"]
+        >>>     __primary__   = ["ID", "name"]
+        >>> 
+        >>> table = Employees(":memory:")
+    """
+
+    __tablename__ : str
+    __columns__   : list[str]
+    __types__     : list[SqlType | str]
+    __primary__   : list[str]
+    __types_sql__ : list[str]
+
+    def __init__(self, database: str | Literal[":memory:"], force_drop : bool = False, **connection_params) -> None:
+        
+        self.database = database
+        self.connection_params = connection_params
+        self._is_managed_transaction = False
+
+        self._validate_attributes()
+        self._register_types()
+        self._write_db(force_drop)
+        
+    
+    def _validate_attributes(self) -> None:
+
+        if not hasattr(self, "__tablename__") or self.__tablename__ is None:
+            self.__tablename__ = self.__class__.__name__
+
+        missing_attrs = [
+            attr for attr in 
+            [ "__columns__", "__types__", "__primary__"] 
+            if not hasattr(self, attr)
+        ]
+
+        if missing_attrs:
+            raise AttributeError(f'{self.tablename} is missing attributes: {missing_attrs}')
+        
+        n_types, n_cols = len(self.__types__), len(self.__columns__)
+
+        if not n_types == n_cols:
+            raise AttributeError(f'`__types__` and `__columns__`: length mismatch: types = {n_types}, columns = {n_cols}')
+        
+        wrong_primaries = [
+            prim for prim in self.__primary__ if
+            prim not in self.__columns__
+        ]
+
+        if wrong_primaries:
+            raise AttributeError(f'`__primary__`: Keys {wrong_primaries} can\'t be primaries as they are not declared in __columns__')
+        
+
+    def _register_types(self) -> None:
+        
+        resolved : list[str] = []
+        assert_register_types = False
+
+        for type_ in self.__types__:
+            
+            if isinstance(type_, str):
+                resolved.append(type_)
+                continue
+            
+            if is_custom_type(type_):
+                ctname = type_.__name__.upper()
+                
+                register_type(type_, ctname)
+                resolved.append(ctname)
+                
+                if not assert_register_types:
+                    assert_register_types = True
+                
+                logger.debug(f'Registered type `{ctname}` in sqlite3')
+                continue 
+            
+            sql_type = pytype_to_sqltype(type_)
+            resolved.append(sql_type)
+        
+        if assert_register_types and ("detect_types" not in self.connection_params):
+            self.connection_params.update(dict(detect_types=sqlite3.PARSE_DECLTYPES))
+
+        self.__types_sql__ = resolved
+        
+
+    def _write_db(self, force_drop : bool) -> None:
+
+        if self.database == ":memory:":
+            logger.debug(f"{self.tablename}: Using in-memory database")
+            return
+        
+        if not os.path.exists(self.database):
+            logger.debug(f'{self.tablename}: {self.database} does not exist. Creating...')
+            parent_dir = self.database.removesuffix(os.path.basename(self.database))
+            if parent_dir: 
+                os.makedirs(parent_dir, exist_ok=True)
+
+        elif force_drop is True:
+            self.drop_table(confirm=True)
+
+        self.create_table()
+
+    
+    def create_table(self) -> None:
+        """ Create table if not exists """
+       
+        query = sql.create_table(
+            self.tablename, self.columns, 
+            self.types_sql, self.primary
+        )
+
+        self.execute(query)
+
+
+    def drop_table(self, confirm : bool = False) -> None:
+        """ Drops table if it exists. """
+        
+        if not confirm:
+            raise ValueError("To drop table you have to pass `confirm=True`")
+        
+        self.execute(sql.drop_table(self.tablename))
+
+
+    def connect(self) -> sqlite3.Connection:
+        """ Shortcut to sqlite3 connection context manager """
+        return sqlite3.connect(self.database, **self.connection_params)
+    
+
+    def open_connection(self) -> None:
+        """ Opens unmanaged transaction """
+        if self.in_transaction():
+            raise RuntimeError("Can't re-open existing connection")
+        
+        self._trans = self.connect()
+        self._trans_cursor = self._trans.cursor()
+
+    
+    def close_connection(self) -> None:
+        """ Closes unmanaged transaction """
+        if not self.in_transaction():
+            return
+        
+        if self._is_managed_transaction:
+            raise RuntimeError("Can't manually close managed transaction")
+        
+        self._trans_cursor.close()
+        self._trans.close()
+        del(self._trans_cursor)
+        del(self._trans)
+
+
+    def commit(self) -> None:
+        if not self.in_transaction():
+            raise RuntimeError("Can't commit outside transaction mode")
+        
+        self._trans.commit()
+
+
+    def rollback(self) -> None:
+        if not self.in_transaction():
+            raise RuntimeError("Can't rollback outside transaction mode")
+        
+        self._trans.rollback()
+    
+
+    @contextmanager
+    def transaction(self, autocommit : bool = True):
+        """ 
+        Creates context manager to use class methods in transaction
+
+        Args:
+            autocommit (bool): If `True`, will commit changes at the end of transaction
+        
+        Examples:
+
+            >>> with table.transaction():
+            >>>     for idx, age in table.select("ID", "Age"):
+            >>>         table.update("Age", age + 1).where.eq("ID", idx).then.execute()
+            >>>     print(table.select)
+        """
+        
+        self.open_connection()
+        self._is_managed_transaction = True
+        logger.debug(f"{self.tablename}: Transaction started")
+        
+        try:
+            yield
+
+        except Exception as e:
+            logger.error(f"{self.tablename}: Error while in transaction: {e}")
+            logger.debug(e, exc_info=True)
+            self._trans.rollback()
+            raise e
+        
+        else:
+            if autocommit:
+                self._trans.commit()
+
+        finally:
+            self._is_managed_transaction = False
+            self.close_connection()
+            logger.debug(f"{self.tablename}: Transaction finished")
+
+    
+    def in_transaction(self) -> bool:
+        """ Returns True if instance is in transaction """
+        return hasattr(self, "_trans") and hasattr(self, "_trans_cursor")
+
+    
+    @overload
+    def _fetch(self, query : str, args : tuple[SqlValue, ...], method : Literal["fetchone"]) -> SqlRow: ...
+    @overload
+    def _fetch(self, query : str, args : tuple[SqlValue, ...], method : Literal["fetchall"]) -> list[SqlRow]: ...
+
+    def _fetch(self, query : str, args : tuple[SqlValue, ...] = (), method : Literal["fetchone", "fetchall"] = "fetchall") -> SqlRow | list[SqlRow]:
+        
+        logger.debug(f"{self.tablename}: {query} {args}")
+
+        if self.in_transaction():
+            self._trans_cursor.execute(query, args)
+            return getattr(self._trans_cursor, method)()
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(query, args)
+            return getattr(cursor, method)()
+
+    
+    @overload    
+    def _execute(self, query : str, args : tuple[SqlValue, ...], method : Literal["execute"]) -> None: ...
+    @overload
+    def _execute(self, query : str, args : Sequence[SqlRow], method : Literal["executemany"]) -> None: ...
+    
+    def _execute(self, query : str, args : tuple[SqlValue, ...] | Sequence[SqlRow] = (), method : Literal["execute", "executemany"] = "execute") -> None:
+        """
+        Shortcut to connect() -> execute[<many>]() -> commit() for single operations. 
+        Can be used in transaction using `transaction()` manager.
+
+        Args:
+            query (str): SQL query to execute on SQLite3 DB
+            *args (Any): Arguments to the execution
+            method (str): "execute" or "executemany"
+        """
+        logger.debug(f"{self.tablename}: {query} {args}")
+
+        if self.in_transaction():
+            getattr(self._trans_cursor, method)(query, args)
+            return
+        
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            getattr(cursor, method)(query, args)
+            conn.commit()
+
+
+    def execute(self, query : str, *args : SqlValue) -> None:
+        """
+        Shortcut to connect() -> execute() -> commit() for single operations. 
+        Can be used in transaction using `transaction()` manager.
+
+        Args:
+            query (str): SQL query to execute on SQLite3 DB
+            *args (tuple[SqlValue, ...]): Arguments to the execution
+        """
+        return self._execute(query, args, method="execute")
+    
+    
+    def executemany(self, query : str, args : Sequence[SqlRow]) -> None:
+        """
+        Shortcut to connect() -> executemany() -> commit() for single operations. 
+        Can be used in transaction using `transaction()` manager.
+
+        Args:
+            query (str): SQL query to execute on SQLite3 DB
+            *args (list[tuple[SqlValue, ...]]): Arguments to the execution
+        """
+        return self._execute(query, args, method="executemany")
+
+
+    def fetchone(self, query : str, *args : SqlValue) -> SqlRow:
+        """
+        Fetch first row based on `query`
+
+        Args:
+            query (str): SQL query
+            *args (tuple[SqlValue, ...]): Arguments to the execution
+
+        Returns:
+            row (SqlRow): Single row
+        """
+        return self._fetch(query, args, method="fetchone")
+    
+
+    def fetchmany(self, query : str, *args : SqlValue, size : int = 1) -> list[SqlRow]:
+        """
+        Fetch first `size` rows based on `query`
+
+        Args:
+            query (str): SQL query
+            *args (tuple[SqlValue, ...]): Arguments to the execution
+            size (str): Number of rows to return
+
+        Returns:
+            rows (list[SqlRow]): list of `size` rows
+        """
+        logger.debug(f"{self.tablename}: {query} {args}")
+
+        if self.in_transaction():
+            self._trans_cursor.execute(query, args)
+            return self._trans_cursor.fetchmany(size)
+
+        with self.connect() as conn:
+            cursor = conn.cursor()
+            cursor.execute(query, args)
+            return cursor.fetchmany(size)
+    
+
+    def fetchall(self, query : str, *args : SqlValue) -> list[SqlRow]:
+        """
+        Fetch all rows based on `query`
+
+        Args:
+            query (str): SQL query
+            *args (tuple[SqlValue, ...]): Arguments to the execution
+
+        Returns:
+            rows (list[SqlRow]): list of rows
+        """
+        return self._fetch(query, args, method="fetchall")
+
+    
+    def insert(self, *args, **kwargs) -> None:
+        """ 
+        Insert single row
+
+        Args:
+            *args (Any): Arguments in order of declared __columns__
+            **kwargs (Any): Unused
+
+        Example:
+            >>> table = MyTable("mydb.db")
+            >>> table.columns 
+            >>> # ["ID", "Name", "Age"]
+            >>> table.insert(0, "Daniel", 27)
+        """
+        query = sql.insert_row(self.tablename, self.columns)
+        self.execute(query, *args)
+
+    
+    def upsert(self, *args, **kwargs) -> None:
+        """ 
+        Upsert (update or insert) single row, resolving conflicts
+        via the declared `primary` key
+        
+        Args:
+            *args (Any): Arguments in order of declared __columns__
+            **kwargs (Any): Unused
+
+        Example:
+            >>> table = MyTable("mydb.db")
+            >>> table.columns 
+            >>> # ["ID", "Name", "Age"]
+            >>> table.upsert(0, "Daniel", 27)
+            >>> table.upsert(0, "Daniel", 21)
+        """
+        query = sql.upsert(self.tablename, self.columns, self.primary)
+        self.execute(query, *args)
+
+    
+    def insert_many(self, rows: Sequence[SqlRow]) -> None:
+        """
+        Bulk insert multiple rows
+        
+        Args:
+            rows (list[SqlRow]): List of tuples, each tuple contains 
+                values for one row in the order of __columns__
+        """
+        query = sql.insert_row(self.tablename, self.columns)
+        return self.executemany(query, rows)
+
+
+    def head(self, n : int = 5) -> list[SqlRow]:
+        """ Returns first `n` rows unordered """
+        return self.select.limit(n).fetchall()
+    
+
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__}("
+            f"database={self.database}, "
+            f"tablename={self.tablename}, "
+            f"columns={sql.format_list(self.columns)}, "
+            f"types={sql.format_list(self.types)}, "
+            f"primary={sql.format_list(self.primary)})"
+        )
+    
+
+    def _repr_html_(self) -> str | None:
+
+        if self.database == ":memory:":
+            return None
+        
+        return to_html(self.tablename, self.columns, self.head(11), 10)
+    
+
+    def __len__(self) -> int:
+        
+        length = self.select.aggregate("COUNT").fetchone()[0]
+        
+        if not isinstance(length, int):
+            raise ValueError("Unreachable")
+        return length
+
+    
+    @overload
+    def __getitem__(self, key : tuple[SqlValue, ...] | SqlValue) -> SqlRow: ...
+    @overload
+    def __getitem__(self, key : slice) -> list[SqlRow]: ...
+    
+    def __getitem__(self, key : tuple[SqlValue, ...] | SqlValue | slice ) -> SqlRow | list[SqlRow]:
+        """ Get row by primary key """
+
+        if len(self.primary) > 1:
+            if (not isinstance(key, tuple)) or (not len(key) == len(self.primary)):
+                raise IndexError("`key` expected to be a tuple of equal leght to `primary` for multi index tables")
+            
+        select = self.select
+
+        if isinstance(key, slice):
+            
+            primary = self.primary[0]
+
+            if key.start is None:
+                start = select(primary).aggregate('MIN').fetchone()[0] or 0
+                select.reset()
+            else:
+                start = key.start
+
+            if key.stop is None:
+                stop = select(primary).aggregate('MAX').fetchone()[0] or 0
+                select.reset()
+            else:
+                stop = key.stop
+
+            if key.step is None:
+                step = 1
+            else:
+                step = key.step
+
+            if not (isinstance(start, int) and isinstance(stop, int)):
+                raise ValueError("Looks like like `primary` key is not integer type, or you passed non-integer slice")
+
+            if abs(step) == 1:
+                _start = min(start, stop)
+                _stop  = max(start, stop)
+                
+                select.order_by(primary, step > 0).where.between(primary, _start, _stop)
+                return select.fetchall()
+            
+            ids = [i for i in range(start, stop, step)]
+  
+            select.order_by(primary, step > 0).where.in_(primary, ids)
+            return select.fetchall()
+        
+        
+        if isinstance(key, tuple):
+
+            for col, val in zip(self.primary, key):
+                select.where.eq(col, val)
+            return select.fetchone()
+
+        select.where.eq(self.primary[0], key)
+        return select.fetchone()
+    
+
+    @property
+    def update(self) -> Update:
+        """ UPDATE statement builder and executor """
+        return Update(self)
+
+    
+    @property
+    def delete(self) -> Delete:
+        """ DELETE statement builder and executor """
+        return Delete(self)
+    
+
+    @property
+    def select(self) -> Select:
+        """ SELECT statement builder and fetcher """
+        return Select(self)
+
+
+    @property
+    def columns(self) -> list[str]:
+        """ List of table column names """
+        return self.__columns__
+
+    
+    @property
+    def types(self) -> list[SqlType | str]:
+        """ List of table column dtypes as declared"""
+        return self.__types__
+    
+    
+    @property
+    def types_sql(self) -> list[str]:
+        """ List of table column dtypes converted to SQL native and registered types """
+        return self.__types_sql__
+
+    
+    @property
+    def primary(self) -> list[str]:
+        """ List of table column primary keys """
+        return self.__primary__
+
+    
+    @property
+    def tablename(self) -> str:
+        """ Name of the table """
+        return self.__tablename__
+    
+
+    @property
+    def shape(self) -> tuple[int, int]:
+        """ Table shape (n_cols, n_rows) """
+        return (len(self.columns), len(self))
+    
+
+    @property
+    def tx_conn(self) -> sqlite3.Connection:
+        """ Gives access to connection while in transaction """
+        if not self.in_transaction():
+            raise RuntimeError("`tx_conn` is not available outside the transaction mode")
+        return self._trans
+    
+    
+    @property
+    def tx_cursor(self) -> sqlite3.Cursor:
+        """ Gives access to connection cursor while in transaction """
+        if not self.in_transaction():
+            raise RuntimeError("`tx_cursor` is not available outside the transaction mode")
+        return self._trans_cursor
+    
+    
+    @property
+    def schema(self) -> Schema:
+        """ Table schema """
+
+        return Schema({
+            "tablename": self.__tablename__,
+            "columns"  : self.__columns__,
+            "types"    : self.__types__,
+            "primary"  : self.__primary__
+        })

sqlengine_lite-2.1.0.dist-info/METADATA

@@ -0,0 +1,287 @@
+Metadata-Version: 2.4
+Name: sqlengine-lite
+Version: 2.1.0
+Summary: Cute sqlite3 wrapper for sql tables
+Project-URL: Homepage, https://github.com/suffermuffin/SQL-Engine
+Project-URL: Repository, https://github.com/suffermuffin/SQL-Engine.git
+Project-URL: Documentation, https://github.com/suffermuffin/SQL-Engine/blob/main/docs/index.md
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+- [Sql-Engine](#sql-engine)
+  - [Features](#features)
+  - [Purpose](#purpose)
+  - [Installation](#installation)
+  - [Env](#env)
+- [Quick Start](#quick-start)
+  - [Table Declaration](#table-declaration)
+  - [Instantiation](#instantiation)
+  - [Row insertion](#row-insertion)
+  - [Jupyter view](#jupyter-view)
+  - [Select Query](#select-query)
+  - [Update Query](#update-query)
+  - [Delete Query](#delete-query)
+  - [Transaction](#transaction)
+  - [Get Item](#get-item)
+  - [Csv Converter](#csv-converter)
+- [Full Documentation](#full-documentation)
+
+
+# Sql-Engine
+
+My Sql-Engine is a cute little wrapper for `sqlite3` table manipulations without any third party dependencies.
+
+
+## Features
+
+Abstracts SQL queries into tiny little methods like, `insert`, `insert_many`, `upsert`, and not so little and tiny query builders a-la `select`, `delete`, `update`, etc. Sql-Engine also provides bulk insertion and transaction methods, like `insert_many` and `select.fetchmany_iterator`. Methods can be executed in transaction mode thanks to `transaction` context manager.
+
+
+Sql-Engine implements Jupyter integration and dynamic schema building. You can easily instantiate existing database table and view it in cute little html representation.
+
+```py
+from sqlengine import schema
+
+table = schema.table_from_database("temp/chinook.db", "Invoice")
+table
+```
+
+<table style="border-collapse: collapse; font-size: 14px;"><caption style="font-size: 18px; font-weight: bold;">Invoice</caption><thead><tr><td style="border: 1px solid #555; text-align: center;">InvoiceId</td><td style="border: 1px solid #555; text-align: center;">CustomerId</td><td style="border: 1px solid #555; text-align: center;">InvoiceDate</td><td style="border: 1px solid #555; text-align: center;">BillingAddress</td><td style="border: 1px solid #555; text-align: center;">BillingCity</td><td style="border: 1px solid #555; text-align: center;">BillingState</td><td style="border: 1px solid #555; text-align: center;">BillingCountry</td><td style="border: 1px solid #555; text-align: center;">BillingPostalCode</td><td style="border: 1px solid #555; text-align: center;">Total</td></tr></thead><tbody><tr><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">2021-01-01 00:00:00</td><td style="border: 1px solid #000; text-align: center;">Theodor-Heuss-Straße 34</td><td style="border: 1px solid #000; text-align: center;">Stuttgart</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">70174</td><td style="border: 1px solid #000; text-align: center;">1.98</td></tr><tr><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">4</td><td style="border: 1px solid #000; text-align: center;">2021-01-02 00:00:00</td><td style="border: 1px solid #000; text-align: center;">Ullevålsveien 14</td><td style="border: 1px solid #000; text-align: center;">Oslo</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">Norway</td><td style="border: 1px solid #000; text-align: center;">0171</td><td style="border: 1px solid #000; text-align: center;">3.96</td></tr><tr><td style="border: 1px solid #000; text-align: center;">3</td><td style="border: 1px solid #000; text-align: center;">8</td><td style="border: 1px solid #000; text-align: center;">2021-01-03 00:00:00</td><td style="border: 1px solid #000; text-align: center;">Grétrystraat 63</td><td style="border: 1px solid #000; text-align: center;">Brussels</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">Belgium</td><td style="border: 1px solid #000; text-align: center;">1000</td><td style="border: 1px solid #000; text-align: center;">5.94</td></tr><tr><td style="border: 1px solid #000; text-align: center;">4</td><td style="border: 1px solid #000; text-align: center;">14</td><td style="border: 1px solid #000; text-align: center;">2021-01-06 00:00:00</td><td style="border: 1px solid #000; text-align: center;">8210 111 ST NW</td><td style="border: 1px solid #000; text-align: center;">Edmonton</td><td style="border: 1px solid #000; text-align: center;">AB</td><td style="border: 1px solid #000; text-align: center;">Canada</td><td style="border: 1px solid #000; text-align: center;">T6G 2C7</td><td style="border: 1px solid #000; text-align: center;">8.91</td></tr><tr><td style="border: 1px solid #000; text-align: center;">5</td><td style="border: 1px solid #000; text-align: center;">23</td><td style="border: 1px solid #000; text-align: center;">2021-01-11 00:00:00</td><td style="border: 1px solid #000; text-align: center;">69 Salem Street</td><td style="border: 1px solid #000; text-align: center;">Boston</td><td style="border: 1px solid #000; text-align: center;">MA</td><td style="border: 1px solid #000; text-align: center;">USA</td><td style="border: 1px solid #000; text-align: center;">2113</td><td style="border: 1px solid #000; text-align: center;">13.86</td></tr><tr><td style="border: 1px solid #000; text-align: center;">6</td><td style="border: 1px solid #000; text-align: center;">37</td><td style="border: 1px solid #000; text-align: center;">2021-01-19 00:00:00</td><td style="border: 1px solid #000; text-align: center;">Berger Straße 10</td><td style="border: 1px solid #000; text-align: center;">Frankfurt</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">60316</td><td style="border: 1px solid #000; text-align: center;">0.99</td></tr><tr><td style="border: 1px solid #000; text-align: center;">7</td><td style="border: 1px solid #000; text-align: center;">38</td><td style="border: 1px solid #000; text-align: center;">2021-02-01 00:00:00</td><td style="border: 1px solid #000; text-align: center;">Barbarossastraße 19</td><td style="border: 1px solid #000; text-align: center;">Berlin</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">10779</td><td style="border: 1px solid #000; text-align: center;">1.98</td></tr><tr><td style="border: 1px solid #000; text-align: center;">8</td><td style="border: 1px solid #000; text-align: center;">40</td><td style="border: 1px solid #000; text-align: center;">2021-02-01 00:00:00</td><td style="border: 1px solid #000; text-align: center;">8, Rue Hanovre</td><td style="border: 1px solid #000; text-align: center;">Paris</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">France</td><td style="border: 1px solid #000; text-align: center;">75002</td><td style="border: 1px solid #000; text-align: center;">1.98</td></tr><tr><td style="border: 1px solid #000; text-align: center;">9</td><td style="border: 1px solid #000; text-align: center;">42</td><td style="border: 1px solid #000; text-align: center;">2021-02-02 00:00:00</td><td style="border: 1px solid #000; text-align: center;">9, Place Louis Barthou</td><td style="border: 1px solid #000; text-align: center;">Bordeaux</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">France</td><td style="border: 1px solid #000; text-align: center;">33000</td><td style="border: 1px solid #000; text-align: center;">3.96</td></tr><tr><td style="border: 1px solid #000; text-align: center;">10</td><td style="border: 1px solid #000; text-align: center;">46</td><td style="border: 1px solid #000; text-align: center;">2021-02-03 00:00:00</td><td style="border: 1px solid #000; text-align: center;">3 Chatham Street</td><td style="border: 1px solid #000; text-align: center;">Dublin</td><td style="border: 1px solid #000; text-align: center;">Dublin</td><td style="border: 1px solid #000; text-align: center;">Ireland</td><td style="border: 1px solid #000; text-align: center;">None</td><td style="border: 1px solid #000; text-align: center;">5.94</td></tr><tr><td colspan="9" style="text-align:center;color:#888;font-style:italic;padding:8px;">... more rows ...</td></tr></tbody></table>
+
+---
+
+You can preview select statements before fetching data to your variables.
+
+```py
+table.select("InvoiceId", "CustomerId", "BillingAddress", "BillingCountry", "Total")\
+    .where\
+        .gte("Total", 2.0)\
+    .then\
+        .order_by("CustomerId")\
+        .limit(10)
+```
+
+<table style="border-collapse: collapse; font-size: 14px;"><caption style="font-size: 18px; font-weight: bold;">Invoice</caption><thead><tr><td style="border: 1px solid #555; text-align: center;">InvoiceId</td><td style="border: 1px solid #555; text-align: center;">CustomerId</td><td style="border: 1px solid #555; text-align: center;">BillingAddress</td><td style="border: 1px solid #555; text-align: center;">BillingCountry</td><td style="border: 1px solid #555; text-align: center;">Total</td></tr></thead><tbody><tr><td style="border: 1px solid #000; text-align: center;">98</td><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">Av. Brigadeiro Faria Lima, 2170</td><td style="border: 1px solid #000; text-align: center;">Brazil</td><td style="border: 1px solid #000; text-align: center;">3.98</td></tr><tr><td style="border: 1px solid #000; text-align: center;">121</td><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">Av. Brigadeiro Faria Lima, 2170</td><td style="border: 1px solid #000; text-align: center;">Brazil</td><td style="border: 1px solid #000; text-align: center;">3.96</td></tr><tr><td style="border: 1px solid #000; text-align: center;">143</td><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">Av. Brigadeiro Faria Lima, 2170</td><td style="border: 1px solid #000; text-align: center;">Brazil</td><td style="border: 1px solid #000; text-align: center;">5.94</td></tr><tr><td style="border: 1px solid #000; text-align: center;">327</td><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">Av. Brigadeiro Faria Lima, 2170</td><td style="border: 1px solid #000; text-align: center;">Brazil</td><td style="border: 1px solid #000; text-align: center;">13.86</td></tr><tr><td style="border: 1px solid #000; text-align: center;">382</td><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">Av. Brigadeiro Faria Lima, 2170</td><td style="border: 1px solid #000; text-align: center;">Brazil</td><td style="border: 1px solid #000; text-align: center;">8.91</td></tr><tr><td style="border: 1px solid #000; text-align: center;">12</td><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">Theodor-Heuss-Straße 34</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">13.86</td></tr><tr><td style="border: 1px solid #000; text-align: center;">67</td><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">Theodor-Heuss-Straße 34</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">8.91</td></tr><tr><td style="border: 1px solid #000; text-align: center;">219</td><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">Theodor-Heuss-Straße 34</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">3.96</td></tr><tr><td style="border: 1px solid #000; text-align: center;">241</td><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">Theodor-Heuss-Straße 34</td><td style="border: 1px solid #000; text-align: center;">Germany</td><td style="border: 1px solid #000; text-align: center;">5.94</td></tr><tr><td style="border: 1px solid #000; text-align: center;">99</td><td style="border: 1px solid #000; text-align: center;">3</td><td style="border: 1px solid #000; text-align: center;">1498 rue Bélanger</td><td style="border: 1px solid #000; text-align: center;">Canada</td><td style="border: 1px solid #000; text-align: center;">3.98</td></tr></tbody></table>
+
+
+## Purpose
+
+It's a tiny little modern ORM that lets you prototype your databases locally with great flexibility. Also, it can be used in production apps to store and retrieve data, because all select, update, delete queries are parametrized. But it does not restrict you from using your own queries which might not be paramerized with methods like `select.custom()` and `where.custom()`.
+
+And last (but not least) is data inspection. If you need to quickly inspect existing .db file but don't want to install yet another heavy ORM with a lot of unused dependencies, you might look into Sql-Engine, as it uses only native python modules.
+
+
+## Installation
+
+To install `sqlengine`, you can use `pip`:
+
+```sh
+pip install sqlengine-lite
+```
+
+## Env
+
+You may set environment variable for logging. By default it's `WARNING`.
+
+```console
+SQL_ENGINE_LOG_LEVEL=INFO
+```
+
+# Quick Start
+
+All you have to do to create your own cute little table is to [inherit](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/table_declaration.md#class-declaration) `SqlTableMixin` class or to create your own [schema](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/table_declaration.md#schema-declaration) and declare desired properties of your table's columns. They are:
+
+
+_Name of the table that will be used in queries. If omitted in inherited class declaration, then it will take the class name._
+```py
+__tablename__ : Optional[str]
+```
+
+_Column names of the table_
+```py
+__columns__ : list[str] 
+```
+
+_Column types of the table_
+```py
+__types__ : list[SqlType | str] 
+```
+
+_List of primary keys_
+```py
+__primary__ : list[str] 
+```
+
+## Table Declaration
+
+More details at [Declaration](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/table_declaration.md#table-declaration).
+
+```py
+from sqlengine import SqlTableMixin
+
+# Helper constants for column names
+ID = "ID"
+Name = "Name"
+Occupation = "Occupation"
+Salary = "Salary"
+
+
+class Employees(SqlTableMixin):
+
+    __columns__   = [ID, Name, Occupation, Salary]
+    __types__     = [int, str, str, float]
+    __primary__   = [ID]
+
+    # You may overwrite your insert methods for type consistency
+    def insert(self, id : int, name : str, occupation : str, salary : float) -> None:
+        return super().insert(id, name, occupation, salary)
+    
+    def upsert(self, id : int, name : str, occupation : str, salary : float) -> None:
+        return super().upsert(id, name, occupation, salary)
+```
+
+## Instantiation
+
+More details at [Instantiation](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/table_declaration.md#table-instantiation).
+
+```py
+# Create an instance of the table class 
+# with provided path to create or connect to
+
+table = Employees("temp/data.db")
+```
+
+## Row insertion
+
+```py
+# Insert one row
+
+table.insert(1, "John Doe", "Software Engineer", 75000.0)
+```
+
+```py
+# Bulk insert multiple rows
+
+employees_data = [
+    (2, "Jane Smith", "Data Scientist", 80000.0),
+    (3, "Alice Johnson", "Product Manager", 90000.0),
+    (4, "Bob Brown", "Project Manager", 78000.0),
+    (5, "Charlie Davis", "UI/UX Designer", 65000.0),
+    (6, "David Wilson", "DevOps Engineer", 82000.0),
+    (7, "Eve Taylor", "Customer Support", 45000.0),
+    (8, "Frank White", "Quality Assurance", 53000.0),
+    (9, "Grace Hall", "Marketing Manager", 68000.0),
+    (10, "Henry Lee", "Technical Writer", 52000.0)
+]
+
+table.insert_many(employees_data)
+```
+
+
+```py
+# Upsert one row
+
+table.upsert(1, "Jane Doe", "Data Scientist", 80000.0)
+```
+
+## Jupyter view
+
+```py
+# Inspect tables in Jupyter Notebook
+
+table
+```
+
+<table style="border-collapse: collapse; font-size: 14px;"><caption style="font-size: 18px; font-weight: bold;">Employees</caption><thead><tr><td style="border: 1px solid #555; text-align: center;">ID</td><td style="border: 1px solid #555; text-align: center;">Name</td><td style="border: 1px solid #555; text-align: center;">Occupation</td><td style="border: 1px solid #555; text-align: center;">Salary</td></tr></thead><tbody><tr><td style="border: 1px solid #000; text-align: center;">1</td><td style="border: 1px solid #000; text-align: center;">Jane Doe</td><td style="border: 1px solid #000; text-align: center;">Data Scientist</td><td style="border: 1px solid #000; text-align: center;">80000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">2</td><td style="border: 1px solid #000; text-align: center;">Jane Smith</td><td style="border: 1px solid #000; text-align: center;">Data Scientist</td><td style="border: 1px solid #000; text-align: center;">80000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">3</td><td style="border: 1px solid #000; text-align: center;">Alice Johnson</td><td style="border: 1px solid #000; text-align: center;">Product Manager</td><td style="border: 1px solid #000; text-align: center;">90000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">4</td><td style="border: 1px solid #000; text-align: center;">Bob Brown</td><td style="border: 1px solid #000; text-align: center;">Project Manager</td><td style="border: 1px solid #000; text-align: center;">78000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">5</td><td style="border: 1px solid #000; text-align: center;">Charlie Davis</td><td style="border: 1px solid #000; text-align: center;">UI/UX Designer</td><td style="border: 1px solid #000; text-align: center;">65000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">6</td><td style="border: 1px solid #000; text-align: center;">David Wilson</td><td style="border: 1px solid #000; text-align: center;">DevOps Engineer</td><td style="border: 1px solid #000; text-align: center;">82000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">7</td><td style="border: 1px solid #000; text-align: center;">Eve Taylor</td><td style="border: 1px solid #000; text-align: center;">Customer Support</td><td style="border: 1px solid #000; text-align: center;">45000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">8</td><td style="border: 1px solid #000; text-align: center;">Frank White</td><td style="border: 1px solid #000; text-align: center;">Quality Assurance</td><td style="border: 1px solid #000; text-align: center;">53000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">9</td><td style="border: 1px solid #000; text-align: center;">Grace Hall</td><td style="border: 1px solid #000; text-align: center;">Marketing Manager</td><td style="border: 1px solid #000; text-align: center;">68000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">10</td><td style="border: 1px solid #000; text-align: center;">Henry Lee</td><td style="border: 1px solid #000; text-align: center;">Technical Writer</td><td style="border: 1px solid #000; text-align: center;">52000.0</td></tr></tbody></table>
+
+## Select Query
+
+More details at [Statements](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/statements.md).
+
+```py
+# Query select and fetch
+
+table.select.where.between(ID, 3, 5).then.fetchall()
+
+# ->
+# [(3, 'Alice Johnson', 'Product Manager', 90000.0),
+#  (4, 'Bob Brown', 'Project Manager', 78000.0),
+#  (5, 'Charlie Davis', 'UI/UX Designer', 65000.0)]
+```
+
+```py
+# Inspect query select in Jupyter
+
+table.select(Name, Salary).where.lt(Salary, 70_000)
+```
+
+<table style="border-collapse: collapse; font-size: 14px;"><caption style="font-size: 18px; font-weight: bold;">Employees</caption><thead><tr><td style="border: 1px solid #555; text-align: center;">Name</td><td style="border: 1px solid #555; text-align: center;">Salary</td></tr></thead><tbody><tr><td style="border: 1px solid #000; text-align: center;">Charlie Davis</td><td style="border: 1px solid #000; text-align: center;">65000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">Eve Taylor</td><td style="border: 1px solid #000; text-align: center;">45000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">Frank White</td><td style="border: 1px solid #000; text-align: center;">53000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">Grace Hall</td><td style="border: 1px solid #000; text-align: center;">68000.0</td></tr><tr><td style="border: 1px solid #000; text-align: center;">Henry Lee</td><td style="border: 1px solid #000; text-align: center;">52000.0</td></tr></tbody></table>
+
+## Update Query
+
+```py
+# equal to ...update.set(Salary, 50_000)...
+table.update(Salary, 50_000).where.eq(Name, "Eve Taylor").then.execute()
+```
+
+## Delete Query
+
+```py
+table.delete.where.eq(ID, 5).then.execute()
+```
+
+## Transaction
+
+More details at [Transaction](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/transactions.md).
+
+```py
+# Operate within a transaction
+
+with table.transaction():
+    for row in employees_data:
+        table.upsert(*row)
+```
+
+## Get Item
+
+More details at [Syntax Sugar](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/syntax_sugar.md).
+
+```py
+# Fetch row by primary key
+
+table[9]
+
+# -> (9, 'Grace Hall', 'Marketing Manager', 68000.0)
+```
+
+```py
+# Fetch slice by integer primary key
+
+table[4:10:2]
+
+# -> 
+# [(4, 'Bob Brown', 'Project Manager', 78000.0),
+#  (6, 'David Wilson', 'DevOps Engineer', 82000.0),
+#  (8, 'Frank White', 'Quality Assurance', 53000.0)]
+```
+
+## Csv Converter
+
+```py
+# Save table to csv
+from sqlengine.utils import to_csv
+
+to_csv(table, "temp/table.csv")
+```
+
+```py
+# Save query result to csv
+
+to_csv(table.select.where.gt(Salary, 70_000), "temp/query.csv")
+```
+
+# Full Documentation
+
+For detailed usage, API reference, and advanced examples, see the [full documentation](https://github.com/suffermuffin/SQL-Engine/blob/main/docs/index.md).

sqlengine_lite-2.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+sqlengine/__init__.py,sha256=s6KuRJuFt3Gxft4tUgW4yPH4_Gs_gTU5C_iAHtET44c,189
+sqlengine/schema.py,sha256=Lpo3w-Hw4sPU2xlQJLFjfHIjRxybNEOjS3SkdInPIJs,3688
+sqlengine/sqltable.py,sha256=Yrn3ULa6iBpwHe67eAlu4Nw9lczVmWb3253FERN173Y,19653
+sqlengine_lite-2.1.0.dist-info/licenses/LICENSE,sha256=aepvve4t1ho5uHMQG88dErp5L5CgoNAXctIjMdoceqY,1069
+sqlengine_lite-2.1.0.dist-info/METADATA,sha256=CMM0K5CTWPxxML39veR87bPgTaDyi_oSQHMl7x4e6z4,23049
+sqlengine_lite-2.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+sqlengine_lite-2.1.0.dist-info/top_level.txt,sha256=KG_FG0LCB_mIEu2qJ5LGLQMpan4QmF5d8xLEcqTghCE,10
+sqlengine_lite-2.1.0.dist-info/RECORD,,

sqlengine_lite-2.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sqlengine_lite-2.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 suffermuffin
+
+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.

sqlengine_lite-2.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sqlengine