database-wrapper-sqlite 0.2.12__py3-none-any.whl

database_wrapper_sqlite/__init__.py

@@ -0,0 +1,24 @@
+"""
+database_wrapper_sqlite package - Sqlite database wrapper
+
+Part of the database_wrapper package
+"""
+
+# Copyright 2024 Gints Murans
+
+import logging
+
+# from .db_wrapper_sqlite import DBWrapperSqlite
+from .connector import SqliteConfig, Sqlite
+
+# Set the logger to a quiet default, can be enabled if needed
+logger = logging.getLogger("database_wrapper_sqlite")
+if logger.level == logging.NOTSET:
+    logger.setLevel(logging.WARNING)
+
+
+__all__ = [
+    # "DBWrapperSqlite",
+    "SqliteConfig",
+    "Sqlite",
+]

database_wrapper_sqlite/connector.py

@@ -0,0 +1,63 @@
+from typing import Any, NotRequired, TypedDict
+
+from database_wrapper import DatabaseBackend
+
+
+class SqliteConfig(TypedDict):
+    database: str
+    kwargs: NotRequired[dict[str, Any]]
+
+
+# TODO: Needs to finish the implementation
+class Sqlite(DatabaseBackend):
+    """
+    Sqlite database backend
+
+    :param config: Configuration for Sqlite
+    :type config: MyConfig
+
+    Defaults:
+        _no defaults_
+    """
+
+    config: SqliteConfig
+
+    connection: Any
+    cursor: Any
+
+    def open(self) -> None:
+        # Free resources
+        if hasattr(self, "connection") and self.connection:
+            self.close()
+
+        # Set defaults
+        if "kwargs" not in self.config or not self.config["kwargs"]:
+            self.config["kwargs"] = {}
+
+        self.logger.debug("Connecting to DB")
+
+        raise NotImplementedError(
+            "Sqlite is not yet implemented. See here: https://github.com/gintsmurans/py_database_wrapper/"
+        )
+
+    def last_insert_id(self) -> int:
+        assert self.cursor, "Cursor is not initialized"
+        return self.cursor.lastrowid
+
+    def affected_rows(self) -> int:
+        assert self.cursor, "Cursor is not initialized"
+        return self.cursor.rowcount
+
+    def commit(self) -> None:
+        """Commit DB queries"""
+        assert self.connection, "Connection is not initialized"
+
+        self.logger.debug("Commit DB queries..")
+        self.connection.commit()
+
+    def rollback(self) -> None:
+        """Rollback DB queries"""
+        assert self.connection, "Connection is not initialized"
+
+        self.logger.debug("Rollback DB queries..")
+        self.connection.rollback()

database_wrapper_sqlite-0.2.12.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: database_wrapper_sqlite
+Version: 0.2.12
+Summary: database_wrapper for PostgreSQL database
+Author-email: Gints Murans <gm@gm.lv>
+License: GNU General Public License v3.0 (GPL-3.0)
+Project-URL: Homepage, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Documentation, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Changes, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Code, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Issue Tracker, https://github.com/gintsmurans/py_database_wrapper/issues
+Project-URL: Download, https://pypi.org/project/database_wrapper/
+Keywords: database,wrapper,python,sqlite
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: database_wrapper==0.2.12
+
+# database_wrapper_sqlite
+
+_Part of the `database_wrapper` package._
+
+This python package is a database wrapper for [sqlite](https://www.sqlite.org/) database.
+
+## !!! IMPORTANT !!!
+
+This package is not yet implemented. The README is a placeholder for future implementation.
+
+## Installation
+
+```bash
+pip install database_wrapper[sqlite]
+```
+
+## Usage
+
+```python
+from database_wrapper_sqlite import Sqlite, DBWrapperSqlite
+
+db = Sqlite({
+    "database": "my_database.db",
+})
+db.open()
+dbWrapper = DBWrapperSqlite(dbCursor=db.cursor)
+
+# Simple query
+aModel = MyModel()
+res = await dbWrapper.getByKey(
+    aModel,
+    "id",
+    3005,
+)
+if res:
+    print(f"getByKey: {res.toDict()}")
+else:
+    print("No results")
+
+# Raw query
+res = await dbWrapper.getAll(
+    aModel,
+    customQuery="""
+        SELECT t1.*, t2.name AS other_name
+        FROM my_table AS t1
+        LEFT JOIN other_table AS t2 ON t1.other_id = t2.id
+    """
+)
+async for record in res:
+    print(f"getAll: {record.toDict()}")
+else:
+    print("No results")
+
+db.close()
+```

database_wrapper_sqlite-0.2.12.dist-info/RECORD

@@ -0,0 +1,7 @@
+database_wrapper_sqlite/__init__.py,sha256=r1Kw78EQGgfsxuiTvTMpY_SWIfjD-h7dLv3NJ6TzJnY,509
+database_wrapper_sqlite/connector.py,sha256=kZtVpBLtdCof5Pjj8fS8EMp0R_z-NQo_EV2kH_crRa0,1635
+database_wrapper_sqlite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+database_wrapper_sqlite-0.2.12.dist-info/METADATA,sha256=NYUt2Ow-POwiVI8LIqS8oiASKcr3eKbrgqQME__aTz4,2823
+database_wrapper_sqlite-0.2.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+database_wrapper_sqlite-0.2.12.dist-info/top_level.txt,sha256=53mm8n6modSF012UMCHllRLbCLajpC0uDwHE0WU1Lxo,24
+database_wrapper_sqlite-0.2.12.dist-info/RECORD,,

database_wrapper_sqlite-0.2.12.dist-info/WHEEL

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

database_wrapper_sqlite-0.2.12.dist-info/top_level.txt

@@ -0,0 +1 @@
+database_wrapper_sqlite