Update README.md

README.md

@@ -1,126 +1,138 @@
-# API Key Validator for OpenAI & Gemini
-
-A lightweight Gradio web app that lets you quickly validate API keys for both OpenAI and Google Gemini (Generative Language API) and view the list of available models for each provider.
-
-## Features
-- Validate OpenAI API key (calls `GET /v1/models`).
-- Validate Gemini API key (calls `GET /v1beta/models`).
-- Secure password-style input fields (keys never echoed in plain text).
-- Immediate feedback: success, failure, and raw error payload when invalid.
-- Displays available model IDs / names returned by each provider.
-- Zero persistence: keys are not stored, logged, or transmitted elsewhere.
-
-## Tech Stack
-- **Python** (>=3.9 recommended)
-- **Gradio** for the UI
-- **Requests** for outbound HTTPS calls
-
-## Getting Started
-### 1. Clone / Download
-```bash
-git clone <your-repo-url>
-cd api-key-tester-app
-```
-(Replace folder name if different.)
-
-### 2. Create Virtual Environment (Optional but Recommended)
-```bash
-python -m venv .venv
-# Windows
-.venv\Scripts\activate
-# macOS / Linux
-source .venv/bin/activate
-```
-
-### 3. Install Dependencies
-```bash
-pip install -r requirements.txt
-```
-
-### 4. Run the App
-```bash
-python app.py
-```
-Gradio will print a local URL (e.g., `http://127.0.0.1:7860`) and, if enabled, a public share URL.
-
-## Usage
-1. Enter your OpenAI API key (format typically starts with `sk-...`).
-2. Enter your Gemini API key (Google AI Studio issued key).
-3. Click **"Test Keys"**.
-4. View validation results and model lists.
-
-If a key is invalid, the raw response body (error JSON / message) is shown in the results panel for troubleshooting.
-
-## Security & Privacy
-- Inputs use `type="password"` in Gradio (no on-screen echo).
-- Keys are only transmitted directly to official provider endpoints.
-- No server-side storage, caching, or logging of keys.
-- Avoid sharing screenshots that contain sensitive error payloads.
-
-## Environment Variables (Optional Enhancement)
-Currently keys are entered manually. You could extend the app to pre-fill from environment variables (example shown for convenience):
-Add to your shell:
-```bash
-# Windows PowerShell
-$Env:OPENAI_API_KEY="sk-your-key"
-$Env:GEMINI_API_KEY="your-gemini-key"
-```
-
-## Error Handling
-- Network errors captured and surfaced as exception strings.
-- Non-200 status codes display provider error payload (`resp.text`).
-- Rate limits or expired keys will return provider-specific error JSON.
-
-## Roadmap / Ideas
-- Add support for additional providers (Anthropic, Mistral, etc.).
-- Show quota usage (if endpoint available).
-- Dark mode toggle.
-- Simple caching of last successful model list.
-- Downloadable validation report.
-
-## Testing
-There are no automated tests yet. Suggested next steps:
-- Unit test helper functions `test_openai_key` and `test_gemini_key` using mocked `requests.get`.
-- Add a smoke test ensuring the Gradio interface launches without exceptions.
-
-## Contributing
-1. Fork the repository.
-2. Create a feature branch: `git checkout -b feature/<name>`.
-3. Commit changes: `git commit -m "Add <feature>"`.
-4. Push: `git push origin feature/<name>`.
-5. Open a Pull Request.
-
-Please keep changes minimal and focused. For significant UI or provider additions, open an issue first to discuss.
-
-## Configuration Notes
-| Provider | Endpoint Used | Purpose |
-|----------|---------------|---------|
-| OpenAI   | `GET https://api.openai.com/v1/models` | Validates key + lists models |
-| Gemini   | `GET https://generativelanguage.googleapis.com/v1beta/models?key=...` | Validates key + lists models |
-
-## Limitations
-- Does not test key against every possible endpoint.
-- Model lists may differ if access is restricted or in preview.
-- No persistent audit trail by design.
-
-## License
-Specify a license (e.g., MIT, Apache-2.0). If none provided, all rights reserved by default.
-
-## Disclaimer
-This tool is for quick manual validation. Always follow provider security best practices and rotate credentials regularly.
-
-## FAQ
-**Q: Are my keys stored anywhere?**  
-A: No. They exist only in session memory for the duration of the Streamlit interaction.
-
-**Q: Why is my valid key showing limited models?**  
-A: Some models require special access or are in restricted beta.
-
-**Q: Can I deploy this?**  
-A: Yes—e.g., Streamlit Community Cloud can run Gradio apps too. Select your GitHub repo, branch `master`, and main file path `app.py`. Leave the App URL blank or choose a simple subdomain. Alternatively, deploy on Spaces (Hugging Face) or Render.
-
-**Q: How can I add another provider?**  
-A: Create a new helper similar to `test_openai_key`, call its endpoint, parse model list, and extend the UI block.
-
----
-Feel free to customize sections like License or add CI badges once the project is in a public repo.
+# API Key Validator for OpenAI & Gemini
+
+# API Key Validator for OpenAI & Gemini
+---
+title: API Key Validator
+emoji: 🔑
+colorFrom: blue
+colorTo: green
+sdk: gradio
+sdk_version: "4.31.0"
+app_file: app.py
+pinned: false
+---
+
+A lightweight Gradio web app that lets you quickly validate API keys for both OpenAI and Google Gemini (Generative Language API) and view the list of available models for each provider.
+
+## Features
+- Validate OpenAI API key (calls `GET /v1/models`).
+- Validate Gemini API key (calls `GET /v1beta/models`).
+- Secure password-style input fields (keys never echoed in plain text).
+- Immediate feedback: success, failure, and raw error payload when invalid.
+- Displays available model IDs / names returned by each provider.
+- Zero persistence: keys are not stored, logged, or transmitted elsewhere.
+
+## Tech Stack
+- **Python** (>=3.9 recommended)
+- **Gradio** for the UI
+- **Requests** for outbound HTTPS calls
+
+## Getting Started
+### 1. Clone / Download
+```bash
+git clone <your-repo-url>
+cd api-key-tester-app
+```
+(Replace folder name if different.)
+
+### 2. Create Virtual Environment (Optional but Recommended)
+```bash
+python -m venv .venv
+# Windows
+.venv\Scripts\activate
+# macOS / Linux
+source .venv/bin/activate
+```
+
+### 3. Install Dependencies
+```bash
+pip install -r requirements.txt
+```
+
+### 4. Run the App
+```bash
+python app.py
+```
+Gradio will print a local URL (e.g., `http://127.0.0.1:7860`) and, if enabled, a public share URL.
+
+## Usage
+1. Enter your OpenAI API key (format typically starts with `sk-...`).
+2. Enter your Gemini API key (Google AI Studio issued key).
+3. Click **"Test Keys"**.
+4. View validation results and model lists.
+
+If a key is invalid, the raw response body (error JSON / message) is shown in the results panel for troubleshooting.
+
+## Security & Privacy
+- Inputs use `type="password"` in Gradio (no on-screen echo).
+- Keys are only transmitted directly to official provider endpoints.
+- No server-side storage, caching, or logging of keys.
+- Avoid sharing screenshots that contain sensitive error payloads.
+
+## Environment Variables (Optional Enhancement)
+Currently keys are entered manually. You could extend the app to pre-fill from environment variables (example shown for convenience):
+Add to your shell:
+```bash
+# Windows PowerShell
+$Env:OPENAI_API_KEY="sk-your-key"
+$Env:GEMINI_API_KEY="your-gemini-key"
+```
+
+## Error Handling
+- Network errors captured and surfaced as exception strings.
+- Non-200 status codes display provider error payload (`resp.text`).
+- Rate limits or expired keys will return provider-specific error JSON.
+
+## Roadmap / Ideas
+- Add support for additional providers (Anthropic, Mistral, etc.).
+- Show quota usage (if endpoint available).
+- Dark mode toggle.
+- Simple caching of last successful model list.
+- Downloadable validation report.
+
+## Testing
+There are no automated tests yet. Suggested next steps:
+- Unit test helper functions `test_openai_key` and `test_gemini_key` using mocked `requests.get`.
+- Add a smoke test ensuring the Gradio interface launches without exceptions.
+
+## Contributing
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/<name>`.
+3. Commit changes: `git commit -m "Add <feature>"`.
+4. Push: `git push origin feature/<name>`.
+5. Open a Pull Request.
+
+Please keep changes minimal and focused. For significant UI or provider additions, open an issue first to discuss.
+
+## Configuration Notes
+| Provider | Endpoint Used | Purpose |
+|----------|---------------|---------|
+| OpenAI   | `GET https://api.openai.com/v1/models` | Validates key + lists models |
+| Gemini   | `GET https://generativelanguage.googleapis.com/v1beta/models?key=...` | Validates key + lists models |
+
+## Limitations
+- Does not test key against every possible endpoint.
+- Model lists may differ if access is restricted or in preview.
+- No persistent audit trail by design.
+
+## License
+Specify a license (e.g., MIT, Apache-2.0). If none provided, all rights reserved by default.
+
+## Disclaimer
+This tool is for quick manual validation. Always follow provider security best practices and rotate credentials regularly.
+
+## FAQ
+**Q: Are my keys stored anywhere?**  
+A: No. They exist only in session memory for the duration of the Streamlit interaction.
+
+**Q: Why is my valid key showing limited models?**  
+A: Some models require special access or are in restricted beta.
+
+**Q: Can I deploy this?**  
+A: Yes—e.g., Streamlit Community Cloud can run Gradio apps too. Select your GitHub repo, branch `master`, and main file path `app.py`. Leave the App URL blank or choose a simple subdomain. Alternatively, deploy on Spaces (Hugging Face) or Render.
+
+**Q: How can I add another provider?**  
+A: Create a new helper similar to `test_openai_key`, call its endpoint, parse model list, and extend the UI block.
+
+---
+Feel free to customize sections like License or add CI badges once the project is in a public repo.