Skip to content

Commit

Permalink
edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
smcalilly committed Sep 26, 2024
1 parent 4a28bac commit 7eab0d9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
A lightweight data pipeline that sends email notifications to subscribers whenever a reservation opens up at their favorite Glacier National Park backcountry campsite. The pipeline is orchestrated by a Makefile that is setup to run automatically as a Github Action.

### Scripts overview
1. Manually add new subscribers with `python backcountry/add_user.py` script, passing arguments with their preferred campsites and dates.
2. `backcountry/get_backcountry_sites.py` gets a list of open campsites and dumps it into a file
3. `backcountry/get_site_availability.py` uses the output of `get_backcountry_sites` to download the availability of each campsite.
1. Manually add new subscribers with `backcountry/add_user.py`, passing arguments with their preferred campsites and dates.
2. `backcountry/get_backcountry_sites.py` gets a list of valid campsites and dumps it into a file.
3. `backcountry/get_site_availability.py` downloads the availability of each campsite.
4. `backcountry/subscriptions.py` checks to see if any of the subscribers' chosen campsites have a reservation opening on their preferred dates.
5. `backcountry/notify.py` notifies subscribers if there was an opening.

Thank you robot! Time to go outside!

0 comments on commit 7eab0d9

Please sign in to comment.