Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ryansurf authored May 31, 2024
1 parent 2483e20 commit cb6736e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Note that when starting with Docker, the `.env` file will be automatically creat
| `SUBJECT` | The email's subject. Default = Surf Report |
| `GPT_PROMPT` | Given the surf data (height, swell direction, etc.), you can tell the GPT what kind of report you would like. For example: `With this data, recommend what size board I should ride and nearby surf spots that may be better with the given conditions.` |
| `API_KEY` | Your OpenAI API key. Optional, the default GPT does not need an API key (and has slighly worse performance). Create one [here](https://platform.openai.com/api-keys) |
| `GPT_MODEL` | The OpenAI GPT model. Default = `gpt-3.5-turbo` (if possible, using `gpt-4o` is recommended.) Explore other models [here](https://platform.openai.com/docs/overview|
| `GPT_MODEL` | The OpenAI GPT model. Default = `gpt-3.5-turbo` (if possible, using `gpt-4o` is recommended.) Explore other models [here](https://platform.openai.com/docs/overview)|


### Email Server
Expand Down

1 comment on commit cb6736e

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
   api.py85693%30, 48, 69–70, 101–102
   art.py9367%24–25, 37
   cli.py26485%33, 51–52, 56
   gpt.py10640%15–20, 27–40
   helper.py1425263%47, 58–62, 95–103, 115, 128–129, 150, 152, 154, 156, 158, 160, 162, 164, 166, 168, 170, 178–180, 190, 192–193, 211–212, 249–259, 266–274
   send_email.py24240%5–48
   server.py41410%5–82
   settings.py210100% 
TOTAL35813662% 

Tests Skipped Failures Errors Time
6 0 💤 0 ❌ 0 🔥 11.327s ⏱️

Please sign in to comment.