Update structure to pyproject.toml

Author: JustinFrizzell

.gitattributes

@@ -18,11 +18,10 @@ RUN apt-get clean \
 
 WORKDIR /app
 
-# Copy requirements and install Python dependencies
-COPY ./requirements.txt ./
-RUN pip install --no-cache-dir -r requirements.txt
-
-# Copy the package and tests
-COPY ./sqlconnect ./sqlconnect
+# Install SQLConnect package and dev dependencies
+COPY ./src ./src
 COPY ./tests ./tests
-
+COPY pyproject.toml README.md ./
+RUN pip install pytest ruff build twine
+RUN python -m build
+RUN pip install dist/*.whl

Dockerfile

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sqlconnect"
+version = "0.3.1"
+authors = [{ name = "Justin Frizzell" }]
+description = "Simplifies connections to SQL databases for data analysts. Populate DataFrames with the results of queries directly from .sql files."
+readme = "README.md"
+keywords = ["SQL", "database", "connection", "configuration"]
+license = { text = "MIT License" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Developers",
+    "Topic :: Database",
+]
+
+requires-python = ">=3.8"
+
+dependencies = [
+    "pandas>=2.0.0",
+    "sqlalchemy>=2.0.0",
+    "pyyaml>=6.0.0",
+    "python-dotenv>=1.0.0",
+    "pyodbc>=5.0.0",
+    "psycopg2-binary>=2.0.0",
+    "oracledb>=2.0.0",
+    "PyMySQL>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/JustinFrizzell/sqlconnect"
+Documentation = "https://sqlconnect.readthedocs.io/en/latest/"
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0.0", "ruff>=0.3.0", "build>1.0.0", "twine>=5.0.0"]

pyproject.toml

@@ -0,0 +1 @@
+from .connector import Sqlconnector  # noqa: F401

requirements-dev.txt

@@ -2,16 +2,16 @@
 This module provides functionality for loading and validating SQL database connection configurations,
 used primarily by the Sqlconnector class for establishing database connections.
 
-The module includes functions to retrieve connection configurations from a YAML file and to construct a 
-database connection URL. It supports dynamic configuration through file paths and dictionaries, and handles 
+The module includes functions to retrieve connection configurations from a YAML file and to construct a
+database connection URL. It supports dynamic configuration through file paths and dictionaries, and handles
 secure storage of sensitive details (e.g., usernames and passwords) through environment variables.
 
 Functions:
     get_connection_config: Retrieves the configuration for a specified connection from a YAML file.
     get_db_url: Constructs and returns a database connection string from a given configuration dictionary.
 
 Used By:
-    - Sqlconnector: This class in a separate module utilises the functions provided here to manage database 
+    - Sqlconnector: This class in a separate module utilises the functions provided here to manage database
       connections and operations.
 
 Dependencies:
@@ -26,12 +26,13 @@
     db_url = get_db_url(config)
 
 Notes:
-    - Configuration files should define connection parameters like 'sqlalchemy_driver', 'odbc_driver', 
+    - Configuration files should define connection parameters like 'sqlalchemy_driver', 'odbc_driver',
       'server', 'database', and optionally 'username', 'password'.
     - Usernames and passwords should be referenced as environment variables in the format '${ENV_VAR}'.
-    - Attempts to load 'sqlconnect.env' files from the current directory or the user's home directory for environment 
+    - Attempts to load 'sqlconnect.env' files from the current directory or the user's home directory for environment
       variables.
 """
+
 import os
 from pathlib import Path
 import yaml

requirements.txt

@@ -1,7 +1,7 @@
 """
-The Sqlconnector class in this module is designed to aid database interactions using SQLAlchemy. 
-It includes methods for establishing database connections, executing SQL queries and commands, 
-and retrieving query results as pandas DataFrames. The class can be configured using either a 
+The Sqlconnector class in this module is designed to aid database interactions using SQLAlchemy.
+It includes methods for establishing database connections, executing SQL queries and commands,
+and retrieving query results as pandas DataFrames. The class can be configured using either a
 configuration file (`sqlconnect.yaml`) or a dictionary.
 
 Classes:
@@ -15,14 +15,15 @@
 
 Example:
     >>> import sqlconnect as sc
-    >>> 
+    >>>
     >>> connection = sc.Sqlconnector("My_Database")
-    >>> 
+    >>>
     >>> df = connection.sql_to_df("path/to/sql_query.sql") # Assign results of a query to a DataFrame
-    >>> 
+    >>>
     >>> print(df.describe()) # Explore the dataframe with Pandas
 
 """
+
 from typing import Union, Generator
 from pathlib import Path
 import pandas as pd