doc: architectural docs

Author: sathninduk

.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish Python Package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  tag-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the code
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.6"
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+
+      # Extract version from setup.py
+      - name: Extract version
+        id: extract_version
+        run: |
+          VERSION=$(python setup.py --version)
+          echo "PACKAGE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      # Create Git tag
+      - name: Create and push Git tag
+        if: ${{ github.ref_name == 'main' }}
+        env:
+          PACKAGE_VERSION: ${{ env.PACKAGE_VERSION }}
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+          git tag -a "v$PACKAGE_VERSION" -m "Release version $PACKAGE_VERSION"
+          git push origin "v$PACKAGE_VERSION"
+
+      # Build the package
+      - name: Build package
+        run: |
+          python setup.py sdist bdist_wheel
+
+      # Publish to PyPI
+      - name: Publish package to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m twine upload dist/*

README.md

@@ -1,6 +1,7 @@
 # ChatWithSQL
 
 **ChatWithSQL** is a Python library that bridges the gap between natural language queries and SQL databases. Designed for reliability, security, and performance, ChatWithSQL allows developers to leverage advanced Language Learning Models (LLMs) like OpenAI, Gemini, and more to retrieve database data using simple, intuitive natural language prompts.
+![Banner.png](docs_src%2Fimages%2FBanner.png)
 
 ## 🎯 Why ChatWithSQL?
 
@@ -143,6 +144,10 @@ Example:
 ]
 ```
 
+## 🗺️ Architecture
+![architecture-diagram.png](docs_src%2Fimages%2Farchitecture-diagram.png)
+
+
 ## 🐛 Logging and Debugging
 
 ChatWithSQL includes extensive logging for better observability: