updating packaging metadata files

.github/workflows/build-docs.yml

@@ -0,0 +1,38 @@
+name: Build Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements.txt
+
+      - name: Build Documentation with Sphinx
+        run: |
+          cd docs
+          make html
+        env:
+          READTHEDOCS: 'True'
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation
+          path: docs/_build/html/

.github/workflows/python-publish.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11" # Specify the exact version used for development
+          python-version: "3.11"
 
       - name: Install dependencies
         run: |
@@ -49,9 +49,9 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/dataanalysistoolkit # Replace <package-name> with your PyPI project name
+      url: https://pypi.org/p/dataanalysistoolkit
     permissions:
-      id-token: write # IMPORTANT: mandatory for trusted publishing
+      id-token: write
 
     steps:
       - name: Download all the dists

.gitignore

@@ -226,4 +226,5 @@ PyPI_Upload.md
 
 archive/
 TODO/
-_build
+_build
+.dist

docs/source/conf.py

@@ -7,13 +7,16 @@
 import sys
 sys.path.insert(0, os.path.abspath('../../src/'))
 
+from dataanalysistoolkit import __version__
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'Data Analysis Toolkit'
 copyright = '2024, Thaddeus Thomas'
 author = 'Thaddeus Thomas'
-release = '1.2.1'
+release = __version__
+version = __version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -38,7 +41,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'latest'
 html_static_path = ['_static']
 
 html_sidebars = {

docs/source/index.rst

@@ -39,6 +39,7 @@ DataAnalysisToolkit is a comprehensive Python package for data analysis, offerin
    Appendices/api_references
    Appendices/changelog
    Appendices/contact_info
+   Appendices/data_import
    Appendices/getting_support
    Appendices/how_to_contribute
    Appendices/reporting_issues

notebooks/tutorial_data_import.ipynb

@@ -88,9 +88,9 @@
    ],
    "source": [
     "# Importing necessary libraries from the toolkit\n",
-    "from ..data_sources import ExcelConnector, SQLConnector, APIConnector\n",
-    "from ..integrators import DataIntegrator\n",
-    "from ..formatters import DataFormatter\n",
+    "from dataanalysistoolkit.data_sources import ExcelConnector, SQLConnector, APIConnector\n",
+    "from dataanalysistoolkit.integrators import DataIntegrator\n",
+    "from dataanalysistoolkit.formatters import DataFormatter\n",
     "\n",
     "# Other libraries you might need\n",
     "import pandas as pd\n"
@@ -123,7 +123,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from src.data_sources.excel_connector import ExcelConnector\n",
+    "from dataanalysistoolkit.data_sources.excel_connector import ExcelConnector\n",
     "\n",
     "# Creating an instance of the ExcelConnector\n",
     "excel_connector = ExcelConnector('path/to/sample_data.xlsx')\n",
@@ -193,7 +193,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ..data_sources import SQLConnector\n",
+    "from dataanalysistoolkit.data_sources import SQLConnector\n",
     "\n",
     "# Initialize the SQLConnector with your database URI\n",
     "sql_connector = SQLConnector('postgresql://username:password@localhost:5432/mydatabase')\n",
@@ -239,7 +239,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ..data_sources import APIConnector\n",
+    "from dataanalysistoolkit.data_sources import APIConnector\n",
     "# Initialize the APIConnector with the base URL and authentication credentials\n",
     "api_connector = APIConnector('https://api.example.com', auth=('username', 'password'))\n",
     "\n",
@@ -324,7 +324,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ..integrators import DataIntegrator\n",
+    "from dataanalysistoolkit.integrators import DataIntegrator\n",
     "# Initialize the Data Integrator\n",
     "integrator = DataIntegrator()\n",
     "\n",