database-wrapper-sqlite 0.1.20__tar.gz → 0.1.33__tar.gz

{database_wrapper_sqlite-0.1.20 → database_wrapper_sqlite-0.1.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: database_wrapper_sqlite
-Version: 0.1.20
+Version: 0.1.33
 Summary: database_wrapper for PostgreSQL database
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -32,4 +32,60 @@ 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.1.28
+Requires-Dist: database_wrapper==0.1.33
+
+# database_wrapper
+
+_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(db=db)
+
+# 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.1.33/README.md

@@ -0,0 +1,55 @@
+# database_wrapper
+
+_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(db=db)
+
+# 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.1.33/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-0.1.33/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):
+        # 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 lastInsertId(self) -> int:
+        assert self.cursor, "Cursor is not initialized"
+        return self.cursor.lastrowid
+
+    def affectedRows(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.1.20 → database_wrapper_sqlite-0.1.33}/database_wrapper_sqlite.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: database_wrapper_sqlite
-Version: 0.1.20
+Version: 0.1.33
 Summary: database_wrapper for PostgreSQL database
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -32,4 +32,60 @@ 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.1.28
+Requires-Dist: database_wrapper==0.1.33
+
+# database_wrapper
+
+_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(db=db)
+
+# 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.1.20 → database_wrapper_sqlite-0.1.33}/database_wrapper_sqlite.egg-info/SOURCES.txt

@@ -1,5 +1,8 @@
+README.md
 pyproject.toml
 database_wrapper_sqlite/__init__.py
+database_wrapper_sqlite/connector.py
+database_wrapper_sqlite/py.typed
 database_wrapper_sqlite.egg-info/PKG-INFO
 database_wrapper_sqlite.egg-info/SOURCES.txt
 database_wrapper_sqlite.egg-info/dependency_links.txt

database_wrapper_sqlite-0.1.33/database_wrapper_sqlite.egg-info/requires.txt

@@ -0,0 +1 @@
+database_wrapper==0.1.33

{database_wrapper_sqlite-0.1.20 → database_wrapper_sqlite-0.1.33}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "database_wrapper_sqlite"
-version = "0.1.20"
+version = "0.1.33"
 description = "database_wrapper for PostgreSQL database"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -35,7 +35,7 @@ classifiers = [
 ]
 keywords = ["database", "wrapper", "python", "sqlite"]
 dependencies = [
-    "database_wrapper == 0.1.28",
+    "database_wrapper == 0.1.33",
 ]
 
 [project.urls]

database_wrapper_sqlite-0.1.20/database_wrapper_sqlite/__init__.py

@@ -1 +0,0 @@
-raise Exception("Not yet implemented")

database_wrapper_sqlite-0.1.20/database_wrapper_sqlite.egg-info/requires.txt

@@ -1 +0,0 @@
-database_wrapper==0.1.28