Skip to content

Commit 873df99

Browse files
johncfrauen-lc101johncfrauen-lc101
committed
init
1 parent a5e80ca commit 873df99

6 files changed

Lines changed: 578 additions & 2 deletions

File tree

‎.gitignore‎

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
# Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
# poetry.lock
109+
# poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
# pdm.lock
116+
# pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
# pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# Redis
135+
*.rdb
136+
*.aof
137+
*.pid
138+
139+
# RabbitMQ
140+
mnesia/
141+
rabbitmq/
142+
rabbitmq-data/
143+
144+
# ActiveMQ
145+
activemq-data/
146+
147+
# SageMath parsed files
148+
*.sage.py
149+
150+
# Environments
151+
.env
152+
.envrc
153+
.venv
154+
env/
155+
venv/
156+
ENV/
157+
env.bak/
158+
venv.bak/
159+
160+
# Spyder project settings
161+
.spyderproject
162+
.spyproject
163+
164+
# Rope project settings
165+
.ropeproject
166+
167+
# mkdocs documentation
168+
/site
169+
170+
# mypy
171+
.mypy_cache/
172+
.dmypy.json
173+
dmypy.json
174+
175+
# Pyre type checker
176+
.pyre/
177+
178+
# pytype static type analyzer
179+
.pytype/
180+
181+
# Cython debug symbols
182+
cython_debug/
183+
184+
# PyCharm
185+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187+
# and can be added to the global gitignore or merged into this file. For a more nuclear
188+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
189+
# .idea/
190+
191+
# Abstra
192+
# Abstra is an AI-powered process automation framework.
193+
# Ignore directories containing user credentials, local state, and settings.
194+
# Learn more at https://abstra.io/docs
195+
.abstra/
196+
197+
# Visual Studio Code
198+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
201+
# you could uncomment the following to ignore the entire vscode folder
202+
# .vscode/
203+
# Temporary file for partial code execution
204+
tempCodeRunnerFile.py
205+
206+
# Ruff stuff:
207+
.ruff_cache/
208+
209+
# PyPI configuration file
210+
.pypirc
211+
212+
# Marimo
213+
marimo/_static/
214+
marimo/_lsp/
215+
__marimo__/
216+
217+
# Streamlit
218+
.streamlit/secrets.toml
219+
220+
claude_cred.txt

‎README.md‎

Lines changed: 109 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,109 @@
1-
# OpenRouter-API-Example
2-
Hello World tutorial for using a LaunchCode-provided OpenRouter API key to access Claude from Python
1+
# OpenRouter Hello Claude Example
2+
3+
This repo is a beginner-friendly example of how to send a simple Claude request through OpenRouter.
4+
5+
For this exercise, LaunchCode provides a course OpenRouter key. You will store that key in a local file named `claude_cred.txt` and use it with the course-approved model `anthropic/claude-haiku-4.5`.
6+
7+
This tutorial uses only Python's standard library, so you do not need to install any extra Python packages.
8+
9+
## What You Will Learn
10+
11+
- How to keep an API key in a local file instead of pasting it into Python code.
12+
- How to run a Python script that sends a request to OpenRouter.
13+
- How to make a successful OpenRouter request to the course-approved model `anthropic/claude-haiku-4.5`.
14+
- How to recognize common OpenRouter error responses for this course key.
15+
16+
## What You Need
17+
18+
- Python 3 installed on your computer.
19+
- The LaunchCode-provided course OpenRouter key.
20+
21+
## Get This Project On Your Computer
22+
23+
You do not need a GitHub account to complete this tutorial.
24+
25+
### Option A: Download ZIP
26+
27+
This is the simplest option if you only need to run the example locally.
28+
29+
1. Open `https://github.com/LaunchCodeEducation/OpenRouter-API-Example`.
30+
2. Click the green **Code** button.
31+
3. Click **Download ZIP**.
32+
4. Unzip the downloaded file.
33+
5. Open the unzipped project folder on your computer.
34+
35+
> The unzipped folder may be named `OpenRouter-API-Example-main`.
36+
37+
### Option B: Clone With Git
38+
39+
If you already have Git installed, you can clone the repo instead.
40+
41+
```bash
42+
git clone https://github.com/LaunchCodeEducation/OpenRouter-API-Example.git
43+
cd OpenRouter-API-Example
44+
```
45+
46+
## Add Your OpenRouter Key
47+
48+
1. In the project folder, create a file named `claude_cred.txt`.
49+
2. Paste the LaunchCode-provided course key into that file.
50+
3. Make sure the file contains only the key.
51+
52+
Do not add quotes, labels, or extra lines.
53+
54+
## Run The Example
55+
56+
### macOS
57+
58+
Use `python3`, not `python`. On many Macs, `python` may point to a different interpreter or may not be available in the way you expect.
59+
60+
```bash
61+
python3 hello_claude.py
62+
```
63+
64+
### Windows
65+
66+
```bat
67+
py hello_claude.py
68+
```
69+
70+
If everything is set up correctly, the script prints a short reply from Claude.
71+
72+
## Keep Your Key Safe
73+
74+
- Do not paste your course key into `hello_claude.py` or any other Python file.
75+
- Do not share your API key with other people.
76+
- Keep `claude_cred.txt` on your own computer.
77+
- This repo already lists `claude_cred.txt` in `.gitignore`, which helps prevent accidental commits if you later use Git.
78+
79+
You do not need to commit or upload anything to complete this tutorial.
80+
81+
If you later decide to store your work in Git or GitHub, make sure files that contain secrets stay ignored and never get uploaded. See GitHub Docs: [Ignoring files](https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files).
82+
83+
## Files In This Repo
84+
85+
- `hello_claude.py`: the minimal Python example for the course-approved OpenRouter call.
86+
- `example-open-router-responses/successful_call_example.json`: an example JSON response from a successful request.
87+
- `example-open-router-responses/example_404_guardrail_error.json`: an example JSON response returned when the request tries a model the course key cannot access.
88+
- `example-open-router-responses/claude-haiku-4.5_model-details.json`: reference details for the course-approved model from OpenRouter.
89+
90+
You send the alias `anthropic/claude-haiku-4.5`, but the JSON response may show a more specific provider model version in the `model` field.
91+
92+
## Troubleshooting
93+
94+
- If Python says it cannot find `claude_cred.txt`, make sure that file is in the same folder as `hello_claude.py`.
95+
- `401 Unauthorized` usually means `claude_cred.txt` does not contain the correct key, or it contains extra whitespace or extra text.
96+
- `404` usually means you tried to use a model outside the access allowed for your course key. For this course, use only `anthropic/claude-haiku-4.5`.
97+
- If your computer says `python3` or `py` is not recognized, Python may not be installed or may not be available in your terminal yet.
98+
- If the script says it could not reach OpenRouter, check your internet connection and try again.
99+
100+
## OpenRouter Language
101+
102+
This example uses Claude through OpenRouter, not through Anthropic's direct API.
103+
104+
That means:
105+
106+
- the credential file is still named `claude_cred.txt`
107+
- the key is still read from a local text file at runtime
108+
- the network request goes to OpenRouter
109+
- the course-approved model is `anthropic/claude-haiku-4.5`

0 commit comments

Comments
 (0)