added unit tests. Added create_sqlite_db() function

Author: Thomas-Rauter

.githubworkflowstest.yml

@@ -0,0 +1,35 @@
+name: Run Unit Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Set up Python environment
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.7"  # Use the Python version your project requires
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      # Run unit tests
+      - name: Run tests
+        run: |
+          python -m unittest discover

README.md

@@ -1,21 +1,20 @@
 # SQLite Query Manager
 
-`sqlite_query_manager` is a Python package designed to efficiently manage and 
+`sqlite_manager` is a Python package designed to efficiently manage and 
 execute SQL queries on SQLite databases. The package supports organizing SQL queries in directories, running them sequentially or selectively, and exporting the results as CSV files. It also includes flexible options to rerun all queries, specific queries, or skip those with existing outputs.
 
 ## Table of Contents
 
 - [Introduction](#introduction)
 - [Usage](#usage)
-  - [Basic Example](#basic-example)
   - [Directory Layouts](#directory-layouts)
 - [Installation](#installation)
 
 ---
 
 ## Introduction
 
-The `sqlite_query_manager` package simplifies SQL query execution workflows by:
+The `sqlite_manager` package simplifies SQL query execution workflows by:
 - Recursively processing SQL queries from directories.
 - Mirroring directory structures for outputs.
 - Avoiding redundant execution of queries unless explicitly specified.
@@ -27,12 +26,49 @@ This makes it ideal for projects involving multiple interdependent queries, such
 
 ## Usage
 
-### Basic Example
+### `create_sqlite_db` function:
 
-Here’s a minimal example of how to use the `run_sql_queries` function:
+```python
+# Import necessary modules
+import pandas as pd
+from sqlite_manager import create_sqlite_db
+
+# Example DataFrame
+data = {
+    "id": [1, 2, 3],
+    "name": ["Alice", "Bob", "Charlie"],
+    "age": [25, 30, 35]
+}
+df = pd.DataFrame(data)
+
+# Path to schema file (must contain the table definition)
+schema_file = "db_schema.sql"
+
+# Example schema (contents of db_schema.sql)
+# CREATE TABLE ExampleTable (
+#     id INTEGER PRIMARY KEY,
+#     name TEXT,
+#     age INTEGER
+# );
+
+# Path to SQLite database file
+db_file = "example_database.db"
+
+# Create SQLite database from the DataFrame
+create_sqlite_db(
+  df,
+  schema_file,
+  db_file
+)
+
+# Verify: The database is created, and data is inserted into the ExampleTable.
+print(f"Database '{db_file}' created successfully with data from the DataFrame.")
+```
+
+### `run_sql_queries` function:
 
 ```python
-from sqlite_query_manager import run_sql_queries 
+from sqlite_manager import run_sql_queries 
 
 query_dir = "sql_queries"          # Directory containing SQL files
 db_file = "data/online_retail.db"  # SQLite database file
@@ -92,10 +128,10 @@ ensuring a clean and organized workflow.
 Install directly from GitHub:
 
 ```bash
-pip install git+https://github.com/Thomas-Rauter/sqlite_query_manager[email protected]
+pip install git+https://github.com/Thomas-Rauter/sqlite_manager[email protected]
 ```
 
 ## When facing problems
 
 For any issues or feature requests, please open an issue on the [GitHub 
-repository](https://github.com/Thomas-Rauter/sqlite_query_manager).
+repository](https://github.com/Thomas-Rauter/sqlite_manager).

requirements.txt

@@ -1,9 +1,9 @@
 from setuptools import setup, find_packages
 
 setup(
-    name="sqlite_query_manager",
+    name="sqlite_manager",
     version="0.1.0",
-    description="A package for managing SQL queries on SQLite databases",
+    description="A package for managing SQLite operations",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     author="Thomas Rauter",

setup.py

@@ -0,0 +1,4 @@
+from .run_sql_queries import run_sql_queries
+from .create_sqlite_db import create_sqlite_db
+
+__all__ = ["run_sql_queries", "create_sqlite_db"]