SQLPyHelper 0.1.4__tar.gz → 0.1.5__tar.gz

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SQLPyHelper
-Version: 0.1.4
+Version: 0.1.5
 Summary: A simple SQL database helper package for Python.
 Home-page: https://github.com/adebayopeter/sqlpyhelper
 Author: Adebayo Olaonipekun
@@ -32,12 +32,12 @@ Requires-Dist: mysql-connector-python; extra == "mysql"
 Provides-Extra: sqlserver
 Requires-Dist: pyodbc; extra == "sqlserver"
 Provides-Extra: oracle
-Requires-Dist: cx_Oracle; extra == "oracle"
+Requires-Dist: oracledb; extra == "oracle"
 Provides-Extra: all
 Requires-Dist: psycopg2; extra == "all"
 Requires-Dist: mysql-connector-python; extra == "all"
 Requires-Dist: pyodbc; extra == "all"
-Requires-Dist: cx_Oracle; extra == "all"
+Requires-Dist: oracledb; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -60,9 +60,17 @@ Dynamic: summary
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/adebayopeter/sqlpyhelper/blob/main/LICENSE)
 [![GitHub stars](https://img.shields.io/github/stars/adebayopeter/sqlpyhelper?style=social)](https://github.com/adebayopeter/sqlpyhelper)
 
-# 📌 SQLPyHelper v.0.1.4 🚀
+SQLPyHelper is a lightweight Python library that gives you a single, consistent API across **SQLite, PostgreSQL, MySQL, SQL Server, and Oracle** — without the overhead of an ORM.
 
-A Python library for simplified database interactions across **SQLite, PostgreSQL, MySQL, SQL Server, and Oracle**. SQLPyHelper provides an intuitive API for handling queries, connection pooling, transactions, logging, and backups efficiently.
+If you need to run queries, manage transactions, pool connections, or back up tables across multiple database types without learning SQLAlchemy's abstraction layer or wiring up five different drivers manually, SQLPyHelper handles that boilerplate for you.
+
+```python
+# Works identically across all five supported databases
+with SQLPyHelper(db_type="postgres", host="localhost", user="user", 
+                 password="pass", database="mydb") as db:
+    db.execute_query("INSERT INTO orders (item) VALUES (%s)", ("Laptop",))
+    results = db.fetch_all()
+```
 
 ## 📖 Table of Contents
 - [🚀 Features](#-features)
@@ -81,7 +89,7 @@ A Python library for simplified database interactions across **SQLite, PostgreSQ
 
 ---
 
-## 🚀 Features in v0.1.3
+## 🚀 Features in v0.1.4
 - Unified connection pooling for multiple databases. 
 - Automatic reconnection for lost connections. 
 - Transaction support (BEGIN, ROLLBACK, COMMIT). 
@@ -92,10 +100,21 @@ A Python library for simplified database interactions across **SQLite, PostgreSQ
 
 ---
 ## 📦 Installation
-#### Install via PyPI:
+
+Install the base package (includes SQLite support out of the box):
 ```sh
 pip install sqlpyhelper
 ```
+
+Install with your database driver:
+```sh
+pip install sqlpyhelper[postgres]    # PostgreSQL
+pip install sqlpyhelper[mysql]       # MySQL
+pip install sqlpyhelper[sqlserver]   # SQL Server
+pip install sqlpyhelper[oracle]      # Oracle
+pip install sqlpyhelper[all]         # All databases
+```
+
 📌 Package on PyPI: [SQLPyHelper on PyPI](https://pypi.org/project/SQLPyHelper/)
 
 For local development:
@@ -208,7 +227,9 @@ db.return_connection_to_pool(conn)
 | `return_connection_to_pool(conn)` | Returns connection back to pool. |
 | `begin_transaction()` | Begins an **explicit transaction**. |
 | `rollback_transaction()` | Rolls back **uncommitted transactions**. |
+| `commit_transaction()` | Commits the current transaction. |
 | `close()` | Closes the database connection safely. |
+| `__enter__` / `__exit__()` | Use as a context manager — connection closes automatically. |
 
 ---
 ## 🌍 Contributing

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/README.md

@@ -6,9 +6,17 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/adebayopeter/sqlpyhelper/blob/main/LICENSE)
 [![GitHub stars](https://img.shields.io/github/stars/adebayopeter/sqlpyhelper?style=social)](https://github.com/adebayopeter/sqlpyhelper)
 
-# 📌 SQLPyHelper v.0.1.4 🚀
+SQLPyHelper is a lightweight Python library that gives you a single, consistent API across **SQLite, PostgreSQL, MySQL, SQL Server, and Oracle** — without the overhead of an ORM.
 
-A Python library for simplified database interactions across **SQLite, PostgreSQL, MySQL, SQL Server, and Oracle**. SQLPyHelper provides an intuitive API for handling queries, connection pooling, transactions, logging, and backups efficiently.
+If you need to run queries, manage transactions, pool connections, or back up tables across multiple database types without learning SQLAlchemy's abstraction layer or wiring up five different drivers manually, SQLPyHelper handles that boilerplate for you.
+
+```python
+# Works identically across all five supported databases
+with SQLPyHelper(db_type="postgres", host="localhost", user="user", 
+                 password="pass", database="mydb") as db:
+    db.execute_query("INSERT INTO orders (item) VALUES (%s)", ("Laptop",))
+    results = db.fetch_all()
+```
 
 ## 📖 Table of Contents
 - [🚀 Features](#-features)
@@ -27,7 +35,7 @@ A Python library for simplified database interactions across **SQLite, PostgreSQ
 
 ---
 
-## 🚀 Features in v0.1.3
+## 🚀 Features in v0.1.4
 - Unified connection pooling for multiple databases. 
 - Automatic reconnection for lost connections. 
 - Transaction support (BEGIN, ROLLBACK, COMMIT). 
@@ -38,10 +46,21 @@ A Python library for simplified database interactions across **SQLite, PostgreSQ
 
 ---
 ## 📦 Installation
-#### Install via PyPI:
+
+Install the base package (includes SQLite support out of the box):
 ```sh
 pip install sqlpyhelper
 ```
+
+Install with your database driver:
+```sh
+pip install sqlpyhelper[postgres]    # PostgreSQL
+pip install sqlpyhelper[mysql]       # MySQL
+pip install sqlpyhelper[sqlserver]   # SQL Server
+pip install sqlpyhelper[oracle]      # Oracle
+pip install sqlpyhelper[all]         # All databases
+```
+
 📌 Package on PyPI: [SQLPyHelper on PyPI](https://pypi.org/project/SQLPyHelper/)
 
 For local development:
@@ -154,7 +173,9 @@ db.return_connection_to_pool(conn)
 | `return_connection_to_pool(conn)` | Returns connection back to pool. |
 | `begin_transaction()` | Begins an **explicit transaction**. |
 | `rollback_transaction()` | Rolls back **uncommitted transactions**. |
+| `commit_transaction()` | Commits the current transaction. |
 | `close()` | Closes the database connection safely. |
+| `__enter__` / `__exit__()` | Use as a context manager — connection closes automatically. |
 
 ---
 ## 🌍 Contributing

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/SQLPyHelper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SQLPyHelper
-Version: 0.1.4
+Version: 0.1.5
 Summary: A simple SQL database helper package for Python.
 Home-page: https://github.com/adebayopeter/sqlpyhelper
 Author: Adebayo Olaonipekun
@@ -32,12 +32,12 @@ Requires-Dist: mysql-connector-python; extra == "mysql"
 Provides-Extra: sqlserver
 Requires-Dist: pyodbc; extra == "sqlserver"
 Provides-Extra: oracle
-Requires-Dist: cx_Oracle; extra == "oracle"
+Requires-Dist: oracledb; extra == "oracle"
 Provides-Extra: all
 Requires-Dist: psycopg2; extra == "all"
 Requires-Dist: mysql-connector-python; extra == "all"
 Requires-Dist: pyodbc; extra == "all"
-Requires-Dist: cx_Oracle; extra == "all"
+Requires-Dist: oracledb; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -60,9 +60,17 @@ Dynamic: summary
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/adebayopeter/sqlpyhelper/blob/main/LICENSE)
 [![GitHub stars](https://img.shields.io/github/stars/adebayopeter/sqlpyhelper?style=social)](https://github.com/adebayopeter/sqlpyhelper)
 
-# 📌 SQLPyHelper v.0.1.4 🚀
+SQLPyHelper is a lightweight Python library that gives you a single, consistent API across **SQLite, PostgreSQL, MySQL, SQL Server, and Oracle** — without the overhead of an ORM.
 
-A Python library for simplified database interactions across **SQLite, PostgreSQL, MySQL, SQL Server, and Oracle**. SQLPyHelper provides an intuitive API for handling queries, connection pooling, transactions, logging, and backups efficiently.
+If you need to run queries, manage transactions, pool connections, or back up tables across multiple database types without learning SQLAlchemy's abstraction layer or wiring up five different drivers manually, SQLPyHelper handles that boilerplate for you.
+
+```python
+# Works identically across all five supported databases
+with SQLPyHelper(db_type="postgres", host="localhost", user="user", 
+                 password="pass", database="mydb") as db:
+    db.execute_query("INSERT INTO orders (item) VALUES (%s)", ("Laptop",))
+    results = db.fetch_all()
+```
 
 ## 📖 Table of Contents
 - [🚀 Features](#-features)
@@ -81,7 +89,7 @@ A Python library for simplified database interactions across **SQLite, PostgreSQ
 
 ---
 
-## 🚀 Features in v0.1.3
+## 🚀 Features in v0.1.4
 - Unified connection pooling for multiple databases. 
 - Automatic reconnection for lost connections. 
 - Transaction support (BEGIN, ROLLBACK, COMMIT). 
@@ -92,10 +100,21 @@ A Python library for simplified database interactions across **SQLite, PostgreSQ
 
 ---
 ## 📦 Installation
-#### Install via PyPI:
+
+Install the base package (includes SQLite support out of the box):
 ```sh
 pip install sqlpyhelper
 ```
+
+Install with your database driver:
+```sh
+pip install sqlpyhelper[postgres]    # PostgreSQL
+pip install sqlpyhelper[mysql]       # MySQL
+pip install sqlpyhelper[sqlserver]   # SQL Server
+pip install sqlpyhelper[oracle]      # Oracle
+pip install sqlpyhelper[all]         # All databases
+```
+
 📌 Package on PyPI: [SQLPyHelper on PyPI](https://pypi.org/project/SQLPyHelper/)
 
 For local development:
@@ -208,7 +227,9 @@ db.return_connection_to_pool(conn)
 | `return_connection_to_pool(conn)` | Returns connection back to pool. |
 | `begin_transaction()` | Begins an **explicit transaction**. |
 | `rollback_transaction()` | Rolls back **uncommitted transactions**. |
+| `commit_transaction()` | Commits the current transaction. |
 | `close()` | Closes the database connection safely. |
+| `__enter__` / `__exit__()` | Use as a context manager — connection closes automatically. |
 
 ---
 ## 🌍 Contributing

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/SQLPyHelper.egg-info/SOURCES.txt

@@ -1,5 +1,7 @@
 LICENSE
 README.md
+pyproject.toml
+setup.cfg
 setup.py
 SQLPyHelper.egg-info/PKG-INFO
 SQLPyHelper.egg-info/SOURCES.txt
@@ -12,5 +14,4 @@ sqlpyhelper/automation_utils.py
 sqlpyhelper/cli.py
 sqlpyhelper/db_helper.py
 sqlpyhelper/py.typed
-test/test_automation.py
 test/test_sqlpyhelper.py

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/SQLPyHelper.egg-info/requires.txt

@@ -5,13 +5,13 @@ click
 psycopg2
 mysql-connector-python
 pyodbc
-cx_Oracle
+oracledb
 
 [mysql]
 mysql-connector-python
 
 [oracle]
-cx_Oracle
+oracledb
 
 [postgres]
 psycopg2

sqlpyhelper-0.1.5/pyproject.toml

@@ -0,0 +1,6 @@
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"
+line_length = 88

sqlpyhelper-0.1.5/setup.cfg

@@ -0,0 +1,21 @@
+[flake8]
+max-line-length = 120
+ignore = 
+	E203,
+	E501,
+	W503
+exclude = 
+	venv,
+	.git,
+	__pycache__,
+	dist,
+	build,
+	*.egg-info
+
+[mypy]
+ignore_missing_imports = True
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as f:
 
 setup(
     name='SQLPyHelper',
-    version='0.1.4',
+    version='0.1.5',
     description='A simple SQL database helper package for Python.',
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -25,12 +25,12 @@ setup(
         "postgres": ["psycopg2"],
         "mysql": ["mysql-connector-python"],
         "sqlserver": ["pyodbc"],
-        "oracle": ["cx_Oracle"],
+        "oracle": ["oracledb"],
         "all": [
             "psycopg2",
             "mysql-connector-python",
             "pyodbc",
-            "cx_Oracle",
+            "oracledb",
         ],
     },
     keywords=[

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/sqlpyhelper/__init__.py

@@ -1,9 +1,9 @@
 # Match the version in setup.py
-__version__ = "0.1.4"
+__version__ = "0.1.5"
 
-from sqlpyhelper.db_helper import (
-    SQLPyHelperError,
+from sqlpyhelper.db_helper import (  # noqa: F401
+    BackupError,
     ConnectionError,
     QueryError,
-    BackupError,
+    SQLPyHelperError,
 )

{sqlpyhelper-0.1.4 → sqlpyhelper-0.1.5}/sqlpyhelper/automation_utils.py

@@ -1,9 +1,11 @@
-import pandas as pd
-from sqlpyhelper.db_helper import SQLPyHelper
-import subprocess
-from datetime import datetime
 import os
 import shutil
+import subprocess
+from datetime import datetime
+
+import pandas as pd
+
+from sqlpyhelper.db_helper import SQLPyHelper
 
 
 class AutomationUtils:
@@ -43,12 +45,17 @@ class AutomationUtils:
                 subprocess.run(
                     [
                         "pg_dump",
-                        "-h", host,
-                        "-p", port,
-                        "-U", user,
+                        "-h",
+                        host,
+                        "-p",
+                        port,
+                        "-U",
+                        user,
                         db_name,
-                        "-F", "c",
-                        "-f", filepath,
+                        "-F",
+                        "c",
+                        "-f",
+                        filepath,
                     ],
                     check=True,
                     shell=False,
@@ -82,7 +89,7 @@ class AutomationUtils:
             entity_column (str): Column representing entity ID.
             date_column (str): Column representing timestamp/date.
         """
-        if self.db.db_type == 'sqlite':
+        if self.db.db_type == "sqlite":
             month_expr = f"strftime('%Y-%m', {date_column})"
         else:
             month_expr = f"DATE_TRUNC('month', {date_column})"
@@ -95,7 +102,9 @@ class AutomationUtils:
         self.db.execute_query(query)
         return self.db.fetch_all()
 
-    def aggregate_column(self, table, value_column, group_column=None, time_column=None):
+    def aggregate_column(
+        self, table, value_column, group_column=None, time_column=None
+    ):
         """
         Computes sum of any value column grouped by entity or month.
 
@@ -105,7 +114,7 @@ class AutomationUtils:
             group_column (str, optional): Entity or category to group by.
             time_column (str, optional): Timestamp to extract month grouping.
         """
-        if self.db.db_type == 'sqlite':
+        if self.db.db_type == "sqlite":
             month_expr = f"strftime('%Y-%m', {time_column})"
         else:
             month_expr = f"DATE_TRUNC('month', {time_column})"
@@ -133,11 +142,13 @@ class AutomationUtils:
             threshold (int): Number of standard deviations from mean to flag as outlier.
         """
         query = f"""
-            SELECT *, {numeric_column} 
-            AS value FROM {table}
+        SELECT *, {numeric_column} AS value FROM {table}
         """
         self.db.execute_query(query)
-        data = pd.DataFrame(self.db.fetch_all(), columns=[desc[0] for desc in self.db.cursor.description])
+        data = pd.DataFrame(
+            self.db.fetch_all(),
+            columns=[desc[0] for desc in self.db.cursor.description],
+        )
 
         mean_val = data["value"].mean()
         std_val = data["value"].std()

sqlpyhelper-0.1.5/sqlpyhelper/cli.py

@@ -0,0 +1,199 @@
+import click
+
+from sqlpyhelper.automation_utils import AutomationUtils
+from sqlpyhelper.db_helper import SQLPyHelper
+
+
+@click.group()
+def cli():
+    """SQLPyHelper Command Line Interface"""
+    pass
+
+
+@cli.command()
+@click.option("--db_type", help="Type of database (e.g., sqlite, postgres, mysql)")
+@click.option("--host", help="Database host")
+@click.option("--user", help="Username")
+@click.option("--password", help="Password")
+@click.option("--database", help="Database name or file")
+@click.option("--query", required=True, help="SQL query to run")
+def run_query(db_type, host, user, password, database, query):
+    """Run a single SQL query and print results"""
+    db = SQLPyHelper(
+        db_type=db_type, host=host, user=user, password=password, database=database
+    )
+    results = db.execute_query(query)
+    for row in results:
+        click.echo(row)
+    db.close()
+
+
+@cli.command()
+@click.option("--db_type", required=True)
+@click.option("--host")
+@click.option("--user")
+@click.option("--password")
+@click.option("--database", required=True)
+def interactive_shell(db_type, host, user, password, database):
+    """Launch an interactive SQL shell"""
+    db = SQLPyHelper(
+        db_type=db_type, host=host, user=user, password=password, database=database
+    )
+    click.echo("Interactive shell started. Type your SQL query or 'exit'")
+    while True:
+        query = input("sqlpy> ")
+        if query.lower() in ("exit", "quit"):
+            break
+        try:
+            db.execute_query(query)
+            results = db.fetch_all()
+            for row in results:
+                click.echo(row)
+        except Exception as e:
+            click.echo(f"Error: {e}")
+    db.close()
+
+
+@cli.command()
+@click.option("--target", default="local", help="Backup destination")
+@click.option("--tag", default="autobackup", help="Tag for backup file naming")
+@click.option("--db-type")
+@click.option("--host")
+@click.option("--user")
+@click.option("--password")
+@click.option("--database")
+@click.option("--port")
+def backup(target, tag, db_type, host, user, password, database, port):
+    """Create a timestamped backup of the connected database."""
+    utils = AutomationUtils(
+        db_type=db_type,
+        host=host,
+        user=user,
+        password=password,
+        database=database,
+        port=port,
+    )
+    utils.backup_database(target=target, tag=tag)
+
+
+@cli.command()
+@click.option("--file", required=True, help="Path to CSV file")
+@click.option("--table", required=True, help="Destination table")
+@click.option(
+    "--if-exists",
+    default="append",
+    type=click.Choice(["append", "replace"]),
+    help="What to do if table exists",
+)
+@click.option("--db-type")
+@click.option("--host")
+@click.option("--user")
+@click.option("--password")
+@click.option("--database")
+@click.option("--port")
+def load_data(file, table, if_exists, db_type, host, user, password, database, port):
+    """Load data from CSV into database table."""
+    utils = AutomationUtils(
+        db_type=db_type,
+        host=host,
+        user=user,
+        password=password,
+        database=database,
+        port=port,
+    )
+    utils.load_data_from_csv(file, table, if_exists=if_exists)
+
+
+@cli.command()
+@click.option("--table", required=True)
+@click.option("--entity-column", required=True)
+@click.option("--date-column", required=True)
+@click.option("--db-type")
+@click.option("--host")
+@click.option("--user")
+@click.option("--password")
+@click.option("--database")
+@click.option("--port")
+def detect_missing_periods(
+    table, entity_column, date_column, db_type, host, user, password, database, port
+):
+    """Flag entities with fewer than 12 months of activity."""
+    utils = AutomationUtils(
+        db_type=db_type,
+        host=host,
+        user=user,
+        password=password,
+        database=database,
+        port=port,
+    )
+    results = utils.detect_missing_periods(table, entity_column, date_column)
+    for row in results:
+        click.echo(row)
+
+
+@cli.command()
+@click.option("--table", required=True)
+@click.option("--value-column", required=True)
+@click.option("--group-column")
+@click.option("--time-column")
+@click.option("--db-type")
+@click.option("--host")
+@click.option("--user")
+@click.option("--password")
+@click.option("--database")
+@click.option("--port")
+def aggregate(
+    table,
+    value_column,
+    group_column,
+    time_column,
+    db_type,
+    host,
+    user,
+    password,
+    database,
+    port,
+):
+    """Aggregate numeric column optionally grouped by entity and time."""
+    utils = AutomationUtils(
+        db_type=db_type,
+        host=host,
+        user=user,
+        password=password,
+        database=database,
+        port=port,
+    )
+    results = utils.aggregate_column(table, value_column, group_column, time_column)
+    for row in results:
+        click.echo(row)
+
+
+@cli.command()
+@click.option("--table", required=True)
+@click.option("--numeric-column", required=True)
+@click.option("--threshold", default=2, type=int)
+@click.option("--db-type")
+@click.option("--host")
+@click.option("--user")
+@click.option("--password")
+@click.option("--database")
+@click.option("--port")
+def detect_outliers(
+    table, numeric_column, threshold, db_type, host, user, password, database, port
+):
+    """Flag rows where values deviate statistically from average."""
+    utils = AutomationUtils(
+        db_type=db_type,
+        host=host,
+        user=user,
+        password=password,
+        database=database,
+        port=port,
+    )
+    results = utils.detect_outliers(table, numeric_column, threshold)
+    for row in results:
+        click.echo(row)
+
+
+if __name__ == "__main__":
+    cli()