Merge remote-tracking branch 'upstream/main'

Author: Kaushalsurana

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,32 @@
+# Cookbook Project Contribution
+
+## Project Overview
+<!-- Provide a concise description of what your project does and the problem it solves -->
+
+## API Integration
+<!-- Describe how your project uses the Perplexity API, including which models and features are leveraged -->
+
+## Impact & Value
+<!-- Explain why this project is valuable to the developer community and how it showcases the API's capabilities -->
+
+## Technical Implementation
+<!-- Briefly describe the technical approach and any notable implementation details -->
+
+## Setup & Dependencies
+<!-- List any dependencies, environment requirements, or setup steps needed -->
+
+## Screenshots/Demo
+<!-- If applicable, include screenshots, demo links, or example outputs -->
+
+## Checklist
+<!-- Mark the following with an 'x' like [x] -->
+
+- [ ] Project is fully functional with no major bugs
+- [ ] Code includes proper error handling
+- [ ] Documentation is complete (README, code comments, etc.)
+- [ ] All credentials/API keys have been removed
+- [ ] Code follows best practices for the language/framework used
+- [ ] Project demonstrates a unique or valuable use case
+
+## Additional Notes
+<!-- Any other information that might be helpful for reviewers -->

CONTRIBUTING.md

@@ -0,0 +1,153 @@
+# Contribution Guidelines for API Cookbook Repository
+
+Thank you for your interest in contributing to our API Cookbook repository! We're looking for high-quality, impactful projects that showcase the capabilities of our API and provide genuine value to developers.
+
+## Project Quality Standards
+
+We prioritize quality over quantity in all contributions. Here's what we look for:
+
+### Technical Requirements
+
+- **Functional Completeness**: Your project should be fully functional, free of bugs, and include proper error handling.
+- **Code Quality**: Code should be clean, well-formatted, well-documented, and follow standard best practices for the language/framework used.
+- **Documentation**: Include comprehensive README with:
+  - Clear description of what the project does
+  - Installation/setup instructions
+  - Usage examples
+  - Explanation of how the API is leveraged
+  - Any limitations or considerations
+- **Maintainability**: Code should be structured to be easily maintained and extended.
+
+### Impact Criteria
+
+We're especially interested in projects that demonstrate one or more of the following:
+
+1. **Solves Real Problems**: Addresses actual use cases that developers might encounter
+2. **Educational Value**: Teaches important concepts about API usage or implementation patterns
+3. **Novel Applications**: Shows innovative or unexpected ways to leverage the API
+4. **Vertical-Specific Solutions**: Demonstrates the API's utility in specific industries or domains
+5. **Integration Examples**: Shows how to effectively combine our API with other tools or services
+
+## Submission Process
+
+1. **Fork the Repository**: Create your own fork of the cookbook repository
+2. **Create a New Directory**: Name it descriptively after your project
+3. **Implement Your Project**: Follow the quality guidelines above
+4. **Test Thoroughly**: Ensure everything works as expected
+5. **Update the README**: Add your project to the README for visibility. 
+5. **Submit a Pull Request**: Include a detailed description of your project and what makes it valuable
+
+## Review Criteria
+
+When reviewing submissions, we evaluate based on:
+
+- **Functionality**: Does it work as described?
+- **Code Quality**: Is the implementation well-crafted?
+- **Originality**: Does it add something new to the cookbook?
+- **Usefulness**: Would other developers find this helpful?
+- **Documentation**: Is it well-explained and easy to follow?
+
+## Examples of High-Impact Projects
+
+- A specialized search application focused on a particular domain (e.g., legal research, academic papers)
+- A browser extension that enhances productivity or learning
+- An automated workflow tool that solves a specific business problem
+- An integration with popular platforms or productivity tools
+- An innovative data visualization of API results
+- A tool addressing a specific industry challenge
+
+## What to Avoid
+
+- Projects with minimal functionality beyond basic API calls
+- Poorly documented implementations
+- Projects that essentially duplicate existing cookbook examples
+- Code with security issues or significant bugs
+- Projects focused on prohibited use cases
+
+Thank you for helping us build a valuable resource for our developer community! We look forward to seeing your innovative applications of our API.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. 
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 perplexity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,42 +1,28 @@
 # Sonar API Projects
 
+![SONAR](assets/perplexity-sonar.png)
+
 A collection of practical applications and tools built with [Perplexity's Sonar API](https://sonar.perplexity.ai/), the fastest, most cost-effective AI answer engine with robust search capabilities.
 
-## ⚠️ API Key Required
+## Contributing
 
-**Before you begin:** You'll need a Perplexity API key to use any project in this repository. 
+Contributions to this repository are welcome! Whether you want to:
 
-Sign up for an API key by following the steps in the [Perplexity documentation](https://docs.perplexity.ai/guides/getting-started).
+- Fix bugs in existing projects
+- Add new features to current tools
+- Contribute entirely new Sonar API projects
+- Improve documentation or examples
 
-## About This Repository
+Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines.
 
-This repository contains various projects that demonstrate how to leverage Perplexity's Sonar API for different use cases. Each project is designed to showcase the API's capabilities while providing practical, ready-to-use tools for developers.
 
 ## Projects
 
-### Fact Checker CLI
-
-The flagship project in this collection is a command-line tool that analyzes claims or articles for factual accuracy. Using Sonar API's powerful search capabilities, it identifies false or misleading statements, provides corrections, and cites reliable sources.
-
-[Read more about the Fact Checker CLI →](./fact-checker/README.md)
-
-### Coming Soon
-
-We're actively working on adding more projects to this collection:
-
-- **Research Assistant**: Automated literature review and summarization tool
-- **News Analyzer**: Track developing stories and analyze reporting biases
-- **Content Verifier**: Browser extension for real-time fact checking
-- **Data Explorer**: Query and visualize complex datasets through natural language
-
-## Why Sonar API?
+• **[Fact Checker CLI](sonar-use-cases/fact_checker_cli/)** - A command-line tool that analyzes claims or articles for factual accuracy using Sonar API's search capabilities.
 
-Perplexity's Sonar API offers several advantages that make it ideal for building powerful AI applications:
+• **[Daily Knowledge Bot](sonar-use-cases/daily_knowledge_bot/)** - Python application that delivers interesting facts about rotating topics using the Perplexity AI API.
 
-- **Fast & Cost-Effective**: Get reliable answers at a fraction of the cost of other AI APIs
-- **Search Grounding**: Internet-connected models that can access and cite the latest information
-- **Easy Integration**: Simple, straightforward API that developers can integrate in minutes
-- **Scalable Pricing**: Pay-as-you-go model that scales with your usage
+• **[Disease Information App](sonar-use-cases/daily_knowledge_bot/)** - Interactive browser-based application providing structured information about diseases using the Sonar API.
 
 ## Getting Started
 
@@ -47,30 +33,8 @@ To use any of the projects in this repository, you'll need:
 
 Each project includes its own README with specific installation and usage instructions.
 
-## API Access
-
-You can sign up for Perplexity's Sonar API at [sonar.perplexity.ai](https://sonar.perplexity.ai/).
-
-The API offers:
-- Free tier to get started
-- Straightforward documentation
-- Transparent usage-based pricing
-
-## Contributing
-
-Contributions to this repository are welcome! Whether you want to:
-
-- Fix bugs in existing projects
-- Add new features to current tools
-- Contribute entirely new Sonar API projects
-- Improve documentation or examples
-
-Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines.
 
 ## License
 
 Unless otherwise specified, all projects in this repository are licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
 
----
-
-*Build with the best AI answer engine. Power your products with the fastest, cheapest API offering out there with search grounding. Get started in minutes.*