Claude/anthropic api example 011 c upnhnuk d5q8wan48 cay5 #484
+237
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a new examples directory with Python examples demonstrating how to use the Anthropic API. Includes: - Basic example showing simple API usage - Advanced example with multi-turn conversations, system prompts, and streaming - Comprehensive README with setup instructions and troubleshooting - Requirements file for easy dependency installation
Add a test script that uses environment variables for the API key, making it easier to test the API connection without hardcoding credentials.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds example code demonstrating how to use the Anthropic API with Python, including basic usage, advanced features, and testing utilities.
- Introduces four new files with examples ranging from basic to advanced API usage
- Includes documentation with setup instructions and troubleshooting guidance
- Provides a requirements.txt file for easy dependency installation
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/anthropic-api/test_api.py | Adds a test script to verify API connectivity with error handling |
| examples/anthropic-api/requirements.txt | Specifies the minimum version of the anthropic package |
| examples/anthropic-api/basic_example.py | Provides a minimal example for getting started with the API |
| examples/anthropic-api/advanced_example.py | Demonstrates advanced features like multi-turn conversations, system prompts, and streaming |
| examples/anthropic-api/README.md | Comprehensive documentation with setup instructions, model information, and troubleshooting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+5
| from anthropic import Anthropic | ||
|
|
||
| # Initialize the client | ||
| client = Anthropic( | ||
| api_key="your-api-key-here" # Replace with your actual API key |
There was a problem hiding this comment.
Hardcoding API keys in example code, even as placeholder text, can lead users to accidentally commit real credentials. Consider using environment variables by default (as done in advanced_example.py) or adding a clear warning comment that this approach should never be used in production or committed to version control.
Suggested change
| from anthropic import Anthropic | |
| # Initialize the client | |
| client = Anthropic( | |
| api_key="your-api-key-here" # Replace with your actual API key | |
| import os | |
| from anthropic import Anthropic | |
| # WARNING: Never hardcode API keys in code or commit them to version control. | |
| # Always use environment variables for secrets in production and development. | |
| # Initialize the client | |
| api_key = os.environ.get("ANTHROPIC_API_KEY") | |
| if not api_key: | |
| raise RuntimeError("Please set the ANTHROPIC_API_KEY environment variable.") | |
| client = Anthropic( | |
| api_key=api_key |
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds a comprehensive set of example files for using the Anthropic API with Python, including documentation, sample scripts, and a requirements file to help users get started quickly. The changes are organized to provide both basic and advanced usage scenarios, as well as guidance on setup and troubleshooting.
Documentation and setup:
README.mdexplaining prerequisites, API key setup, usage instructions for example scripts, available models, common issues, and support resources.requirements.txtspecifying the minimum required version of the Anthropic Python SDK for compatibility.Example scripts:
basic_example.pyshowing a minimal usage scenario for sending a message to the Anthropic API.advanced_example.pywith multiple functions demonstrating simple conversation, multi-turn exchanges, system prompt usage, and streaming responses.test_api.pyto verify API connectivity and provide immediate feedback on the setup, including error handling for missing API keys.