Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add installation instructions #4

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add installation instructions #4

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2582e0
Add installation instructions
bryanwhiting Jul 27, 2022
0b97aa8
Update README.md
bryanwhiting Jul 27, 2022
d63d2fa
Add finding campsites helper
bryanwhiting Jul 27, 2022
b241545
Update README.md
bryanwhiting Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# Campsite availability via CLI

Installation:
```
git clone https://github.com/ggydush/campsites.git
cd campsites
poetry install
```
Requires python 3.9. If you don't have python3, here are some suggested steps:

1. install python 3.9 here: https://www.python.org/downloads/release/python-390/
2. install pip https://phoenixnap.com/kb/install-pip-mac
3. `git clone https://github.com/ggydush/campsites.git`
4. `cd campsites`
5. create virtual enviroment: `python3 -m venv venv3.9campsites`
6. activate venv: `source venv3.9campsites/bin/activate`
7. install poetry: `pip3 install poetry`
8. install the campsites package: `poetry install`
9. `find-campsites --help` or `poetry run find-campsites`

You can still use with other python versions (like 3.7), but you need to adapt the code. See [issue 3](https://github.com/ggydush/campsites/issues/3).

# Usage
Small tool to check for campsite availability and notify via text message using Twilio.

```
Expand Down Expand Up @@ -65,3 +86,27 @@ TWILIO_AUTH_TOKEN="YOUR_TWILIO_AUTH"
TWILIO_FROM_NUMBER="YOUR_TWILIO_NUMBER"
TWILIO_TO_NUMBER = "YOUR_PHONE_NUMBER"
```

# Finding Campsites
Enter the name of the campground as it appears on https://www.reservecalifornia.com/Web/ and `find-campsites` will return a table of facilities. Then use that facility id to search for availability. The other way to find the campsite ID is in the URL after getting deep into the booking. For Big Basin Redwoods, which ahs campground id of 3, the facility_id could be 333 for Seqouia group. See https://www.reservecalifornia.com/Web/#!park/3/333 to compare.

```
❯ find-campsites -c "Big Basin Redwoods SP" --api reservecalifornia
INFO 2022-07-26 22:04:38,880 ReserveCalifornia must use facility ID. Searching for facility IDs using provided `campground_id` (note: this must be the park that the campground is in)
INFO 2022-07-26 22:04:39,158 Found campground: Big Basin Redwoods SP (campground id: 3)
INFO 2022-07-26 22:04:39,375 Found facilities in park:

campground facility_id
Huckleberry Campground (sites 42-75) 336
Lower Blooms Creek (sites 103-138) 332
Sempervirens Campground (sites 157-188) 335
Sequoia Group 1 & 2 333
Sky Meadow Group 1 & 2 338
Upper Blooms Creek (sites 139-156) 339
Wastahi Campground (sites 76-102) 337

<ctrl+c> to exit
❯ find-campsites -c 336 --api reservecalifornia
INFO 2022-07-26 22:05:50,679 Found campground: Huckleberry Campground (sites 42-75) (campground id: 336)
INFO 2022-07-26 22:05:50,680 No availability found for 336 :( Trying again in 5 minutes.
```