Skip to content

Commit

Permalink
Merge pull request #60 from vaibhav-2703/update-help-file
Browse files Browse the repository at this point in the history
Update help.txt
  • Loading branch information
ryansurf authored Jul 25, 2024
2 parents 3d89bf2 + 1c13898 commit 36c91ce
Showing 1 changed file with 25 additions and 17 deletions.
42 changes: 25 additions & 17 deletions help.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Usage:

$ curl localhost:8000 # current location
$ curl localhost:8000?args=loc=new_york # surf report in New new_york
$ curl localhost:8000?loc=new_york # surf report in New York

Supported location types:

Expand All @@ -18,26 +18,34 @@ Units:

Arguments:

location / loc #Specify the location of your forecast
forecast / fc # Number of forecast days. Max = 7, default = 0
hide_wave / hw # Hide the default wave art
show_large_wave / slw # Show the large wave art
hide_uv / huv # Hide uv index
hide_height / hh # Hide surf height
hide_direction / hdir # Hide Swell direction
hide_period / hp # Hide swell period
hide_location / hl # Hide location
hide_date / hdate # Hide date in forecast
metric / m # Numbers in Metric units. Defaults to Imperial
decimal / dec # Specify decimal points in output
color / c # Choose color of wave art. Ex: color=light_blue
location / loc # Specify the location of your forecast
forecast / fc # Number of forecast days. Max = 7, default = 0
hide_wave / hw # Hide the default wave art
show_large_wave / slw # Show the large wave art
show_air_temp / sat # Show the air temperature
show_wind_speed / sws # Show the wind speed
show_wind_direction / swd # Show the wind direction
hide_uv / huv # Hide UV index
hide_height / hh # Hide surf height
hide_direction / hdir # Hide swell direction
hide_period / hp # Hide swell period
hide_location / hl # Hide location
hide_date / hdate # Hide date in forecast
metric / m # Numbers in Metric units. Defaults to Imperial
decimal / dec # Specify decimal points in output
color / c # Choose color of wave art. Ex: color=light_blue
json / j # Output the data in JSON format. Must be the only argument
gpt / g # Activates the GPT surf report. Change the GPT_PROMPT variable in .env to customize responses. Default = off

Color Options:

defualt, red, green, yellow, blue, purple, teal, light_blue
default, red, green, yellow, blue, purple, teal, light_blue

Examples:

curl localhost:8000
curl localhost:8000?args=location=new_york,hide_height,hide_wave,show_large_wave
curl localhost:8000?args=fc=3,hdate,loc=trestles,c=light_blue
curl localhost:8000?loc=new_york,hide_height,hide_wave,show_large_wave
curl localhost:8000?fc=3,hdate,loc=trestles,c=light_blue
curl localhost:8000?loc=malibu,show_air_temp,show_wind_speed,show_wind_direction
curl localhost:8000?loc=nazare,json
curl localhost:8000?loc=gold_coast,gpt,color=yellow

1 comment on commit 36c91ce

@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.py105694%30, 48, 70–71, 103–104
   art.py9367%24–25, 37
   cli.py23483%34, 50–51, 55
   gpt.py10640%16–21, 32–45
   helper.py1576062%53, 55, 57, 59, 61, 63, 65, 67, 69, 71, 73, 75, 77, 79, 91, 102–106, 132, 134, 136, 145–155, 167, 180–181, 199–201, 211, 213–214, 236–237, 275–285, 292–300
   send_email.py24240%5–48
   server.py41410%5–82
   settings.py220100% 
TOTAL39114463% 

Tests Skipped Failures Errors Time
9 0 💤 0 ❌ 0 🔥 14.531s ⏱️

Please sign in to comment.