search

juftin / camply

camply, the campsite finder ⛺️ - a tool to find campsites at sold out campgrounds through sites like recreation.gov
https://juftin.com/camply/
MIT License
485 stars 94 forks source link
camping goingtocamp national-parks notifications outdoors python recreation recreation-gov reservations reservecalifornia state-parks yellowstone

readme

camply

camply, the campsite finder ⛺️, is a tool to help you book a campsite online. Finding reservations at sold out campgrounds can be tough. That's where camply comes in. It searches thousands of campgrounds across the USA world via the APIs of booking services like recreation.gov. It continuously checks for cancellations and availabilities to pop up - once a campsite becomes available, camply sends you a notification to book your spot!

PyPI PyPI - Python Version Docker Image Version Testing Status GitHub License Ruff pre-commit semantic-release Gitmoji Discord Chat

Check Out The Docs

Installing

Install camply via pip or pipx:

pipx install camply

Usage

Search for a specific recreation area (recreation areas contain campgrounds):

camply recreation-areas --search "Glacier National Park"

Search for campgrounds (campgrounds contain campsites):

camply campgrounds --search "Fire Lookout Towers" --state CA

Search for available campsites, get a notification whenever one becomes available, and continue searching after the first one is found. The below command is using silent notifications as an example but camply also supports Email, Slack, Twilio (SMS), Pushover, Pushbullet, Ntfy, Apprise, Telegram, and Webhook.

camply campsites \
    --rec-area 2725 \
    --start-date 2023-07-10 \
    --end-date 2023-07-18 \
    --notifications silent \
    --search-forever

Providers

camply works with a number of providers. A "provider" is an online booking service that lists camping and recreation inventory.

Run camply providers to list current providers and visit the Providers section in the docs to learn more.

Documentation

Head over to the camply documentation to see what you can do!

❯ camply --help

 Usage: camply [OPTIONS] COMMAND [ARGS]...

 Welcome to camply, the campsite finder.
 Finding reservations at sold out campgrounds can be tough. That's where camply comes in. It searches the
 APIs of booking services like https://recreation.gov (which indexes thousands of campgrounds across the
 USA) to continuously check for cancellations and availabilities to pop up. Once a campsite becomes
 available, camply sends you a notification to book your spot!

 visit the camply documentation at https://juftin.com/camply

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────╮
│                                                                                                        │
│  --debug/--no-debug             Enable extra debugging output                                          │
│  --provider              TEXT   Camping Search Provider. Defaults to 'RecreationDotGov'                │
│  --version                      Show the version and exit.                                             │
│  --help                         Show this message and exit.                                            │
│                                                                                                        │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────╮
│                                                                                                        │
│  campgrounds              Search for Campgrounds (inside of Recreation Areas) and list them            │
│  campsites                Find Available Campsites with Custom Search Criteria                         │
│  configure                Set up camply configuration file with an interactive console                 │
│  equipment-types          Get a list of supported equipment                                            │
│  list-campsites           List campsite IDs for a given campground or recreation area                  │
│  providers                List the different camply providers                                          │
│  recreation-areas         Search for Recreation Areas and list them                                    │
│  test-notifications       Test your notification provider setup                                        │
│  tui                      Open Textual TUI.                                                            │
│                                                                                                        │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Contributing

Camply doesn't support your favorite campsite booking provider yet? Consider contributing 😉.


Recreation data provided by Recreation.gov


juftin logo