template init: simple chatbot

.gitignore

@@ -0,0 +1,59 @@
+# Virtual environment
+gradio-env/
+
+# Python cache files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# PyCharm
+.idea/
+
+# VS Code
+.vscode/
+
+# Environment variables
+.env
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Gradio specific
+flagged/
+
+# Logs
+*.log

README_DEV.md

@@ -0,0 +1,131 @@
+To run Gradio apps locally using Windows Subsystem for Linux (WSL) and Visual Studio Code (VSCode), follow these steps:
+
+## **1. Set Up WSL**
+
+### **Enable WSL**
+1. **Windows Features Dialog:**
+   - Open the Windows search bar, type "features," and select *Turn Windows Features on or off*.
+   - Scroll down and check *Windows Subsystem for Linux*.
+   - Click *OK* and restart your computer.
+
+2. **PowerShell:**
+   - Open PowerShell as an Administrator and run:
+     ```powershell
+     Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
+     ```
+   - Restart your computer when prompted.
+
+### **Install a Linux Distro**
+1. Open the Microsoft Store and search for a Linux distribution (e.g., Ubuntu).
+2. Install and launch the distribution.
+3. Follow the prompts to complete the installation and create a user ID and password.
+
+## **2. Set Up Visual Studio Code with WSL**
+
+### **Install VSCode and WSL Extension**
+1. Download and install [Visual Studio Code](https://code.visualstudio.com/).
+2. Install the *Remote - WSL* extension from the VSCode marketplace.
+
+### **Open a WSL Terminal in VSCode**
+1. Open your WSL terminal (e.g., Ubuntu).
+2. Navigate to your project directory.
+3. Type `code .` to open the current directory in VSCode.
+
+## **3. Install and Run Gradio in a Virtual Environment**
+
+### **Create a Virtual Environment**
+1. In your WSL terminal, navigate to your project directory:
+   ```bash
+   cd /path/to/your/project
+   ```
+2. Create a virtual environment:
+   ```bash
+   python3 -m venv gradio-env
+   ```
+3. Activate the virtual environment:
+   ```bash
+   source gradio-env/bin/activate
+   ```
+
+### **Install Gradio**
+1. With the virtual environment activated, install Gradio:
+   ```bash
+   pip install gradio
+   ```
+
+### **Run the App**
+
+   ```
+2. Run the Gradio app:
+   ```bash
+   python app.py
+   ```
+3. The app will open in a browser at `http://localhost:7860`.
+
+### **Hot Reload Mode (Optional)**
+For development convenience, you can use Gradio's hot reload mode:
+```bash
+gradio app.py
+```
+
+This setup allows you to develop and run Gradio apps efficiently using WSL and VSCode, leveraging the power of a Linux environment on a Windows machine[1][3][4][5].
+
+Citations:
+[1] https://code.visualstudio.com/docs/remote/wsl-tutorial
+[2] https://learn.microsoft.com/en-us/windows/ai/toolkit/toolkit-fine-tune
+[3] https://www.gradio.app/guides/quickstart
+[4] https://code.visualstudio.com/docs/remote/wsl
+[5] https://www.gradio.app/guides/installing-gradio-in-a-virtual-environment
+
+To automatically create and update a requirements.txt file for your Python application, you have several options. Here are the most effective methods:
+
+# Updating the requirements.txt
+
+## **Using pipreqs (Recommended)**
+
+Pipreqs is a third-party tool that analyzes your project's imports and generates a more accurate requirements.txt file[4][8].
+
+1. Install pipreqs:
+   ```bash
+   pip install pipreqs
+   ```
+2. Navigate to your project directory.
+3. Run pipreqs:
+   ```bash
+   pipreqs .
+   ```
+
+Pipreqs will scan your project, identify the imports, and create a requirements.txt file with only the packages your project actually uses[4][8].
+
+## **TODO Automating with GitHub Actions**
+
+For projects hosted on GitHub, you can automate the process using GitHub Actions:
+
+1. Create a workflow file (e.g., `.github/workflows/update-requirements.yml`).
+2. Use an action like `timmypidashev/auto-pipreqs-cpy@master` to automatically generate the requirements.txt file[5].
+
+## **Best Practices**
+
+1. **Use virtual environments**: This ensures your requirements.txt only includes project-specific dependencies[4].
+2. **Specify versions**: Use `==` to pin exact versions for reproducibility[4].
+3. **Update regularly**: Keep your requirements.txt up to date as you add or remove dependencies[4].
+4. **Review generated files**: Always review automatically generated requirements.txt files to ensure they're accurate and complete[6].
+
+By following these methods and best practices, you can efficiently manage your Python project's dependencies and ensure consistency across different environments.
+
+Citations:
+[1] https://stackoverflow.com/questions/31684375/automatically-create-file-requirements-txt
+[2] https://www.mend.io/free-developer-tools/a/community/software-dependencies/how-can-i-automatically-generate-and-update-a-requirements-txt-file-from-a-pipfile-using-pipenv/
+[3] https://stackoverflow.com/questions/24764549/upgrade-python-packages-from-requirements-txt-using-pip-command
+[4] https://www.squash.io/how-to-automatically-create-requirementstxt-in-python/
+[5] https://github.com/marketplace/actions/automatic-requirements-txt-generation-for-python-projects
+[6] https://pynwb.readthedocs.io/en/stable/update_requirements.html
+[7] https://www.geeksforgeeks.org/how-to-create-requirements-txt-file-in-python/
+[8] https://www.youtube.com/watch?v=0ZeoruSobc4
+[9] https://www.paleblueapps.com/rockandnull/python-update-requirements-txt/
+[10] https://www.scaler.com/topics/how-to-create-requirements-txt-python/
+[11] https://learn.microsoft.com/en-us/visualstudio/python/managing-required-packages-with-requirements-txt?view=vs-2022
+[12] https://www.jetbrains.com/help/pycharm/managing-dependencies.html
+[13] https://note.nkmk.me/en/python-pip-install-requirements/
+[14] https://www.freecodecamp.org/news/python-requirementstxt-explained/
+[15] https://learnpython.com/blog/python-requirements-file/

app.py

@@ -0,0 +1,30 @@
+import gradio as gr
+from openai import OpenAI
+from utils import get_secret
+
+# Initialize the OpenAI client
+client = OpenAI(api_key=get_secret('OPENAI_API_KEY'))
+
+def generate_response(prompt):
+    try:
+        response = client.chat.completions.create(
+            model="gpt-3.5-turbo",
+            messages=[
+                {"role": "system", "content": "You are a helpful assistant."},
+                {"role": "user", "content": prompt}
+            ]
+        )
+        return response.choices[0].message.content
+    except Exception as e:
+        return str(e)
+
+demo = gr.Interface(
+    fn=generate_response,
+    inputs="text",
+    outputs="text",
+    title="OpenAI GPT-3.5 Turbo Chatbot",
+    description="Enter a prompt to get a response from OpenAI's GPT-3.5 Turbo model."
+)
+
+if __name__ == "__main__":
+    demo.launch()

requirements.txt

@@ -0,0 +1,111 @@
+aiofiles==23.2.1
+altair==5.3.0
+annotated-types==0.7.0
+anyio==4.4.0
+asttokens==2.4.1
+attrs==23.2.0
+backcall==0.2.0
+beautifulsoup4==4.12.3
+bleach==6.1.0
+build==1.2.1
+certifi==2024.7.4
+charset-normalizer==3.3.2
+click==8.1.7
+contourpy==1.2.1
+cycler==0.12.1
+decorator==5.1.1
+defusedxml==0.7.1
+distro==1.9.0
+dnspython==2.6.1
+docopt==0.6.2
+email_validator==2.2.0
+executing==2.0.1
+fastapi==0.111.1
+fastapi-cli==0.0.4
+fastjsonschema==2.20.0
+ffmpy==0.3.2
+filelock==3.15.4
+fonttools==4.53.1
+fsspec==2024.6.1
+gradio==4.38.1
+gradio_client==1.1.0
+h11==0.14.0
+httpcore==1.0.5
+httptools==0.6.1
+httpx==0.27.0
+huggingface-hub==0.23.5
+idna==3.7
+importlib_resources==6.4.0
+ipython==8.12.3
+jedi==0.19.1
+Jinja2==3.1.4
+jsonschema==4.23.0
+jsonschema-specifications==2023.12.1
+jupyter_client==8.6.2
+jupyter_core==5.7.2
+jupyterlab_pygments==0.3.0
+kiwisolver==1.4.5
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
+matplotlib==3.9.1
+matplotlib-inline==0.1.7
+mdurl==0.1.2
+mistune==3.0.2
+nbclient==0.10.0
+nbconvert==7.16.4
+nbformat==5.10.4
+numpy==2.0.0
+openai==1.35.14
+orjson==3.10.6
+packaging==24.1
+pandas==2.2.2
+pandocfilters==1.5.1
+parso==0.8.4
+pexpect==4.9.0
+pickleshare==0.7.5
+pillow==10.4.0
+platformdirs==4.2.2
+prompt_toolkit==3.0.47
+ptyprocess==0.7.0
+pure-eval==0.2.2
+pydantic==2.8.2
+pydantic_core==2.20.1
+pydub==0.25.1
+Pygments==2.18.0
+pyparsing==3.1.2
+pyproject_hooks==1.1.0
+python-dateutil==2.9.0.post0
+python-dotenv==1.0.1
+python-multipart==0.0.9
+pytz==2024.1
+PyYAML==6.0.1
+pyzmq==26.0.3
+referencing==0.35.1
+requests==2.32.3
+rich==13.7.1
+rpds-py==0.19.0
+ruff==0.5.2
+semantic-version==2.10.0
+shellingham==1.5.4
+six==1.16.0
+sniffio==1.3.1
+soupsieve==2.5
+stack-data==0.6.3
+starlette==0.37.2
+tinycss2==1.3.0
+tomlkit==0.12.0
+toolz==0.12.1
+tornado==6.4.1
+tqdm==4.66.4
+traitlets==5.14.3
+typer==0.12.3
+typing_extensions==4.12.2
+tzdata==2024.1
+urllib3==2.2.2
+uvicorn==0.30.1
+uvloop==0.19.0
+watchfiles==0.22.0
+wcwidth==0.2.13
+webencodings==0.5.1
+websockets==11.0.3
+yarg==0.1.9

utils.py

@@ -0,0 +1,27 @@
+import os
+from dotenv import load_dotenv
+
+def get_secret(key: str, default: str = None) -> str:
+    """
+    Retrieve a secret from environment variables or .env file.
+    
+    Args:
+    key (str): The name of the secret/environment variable.
+    default (str, optional): A default value if the secret is not found.
+    
+    Returns:
+    str: The value of the secret, or the default value if not found.
+    """
+    # Load .env file if it exists (for local development)
+    load_dotenv()
+    
+    # Try to get the secret from environment variables
+    secret = os.getenv(key)
+    
+    if secret is None:
+        if default is not None:
+            return default
+        else:
+            raise ValueError(f"Secret '{key}' not found in environment variables and no default provided.")
+    
+    return secret