GithubHelp home page GithubHelp logo

ethan-leba / camply Goto Github PK

View Code? Open in Web Editor NEW

This project forked from juftin/camply

0.0 0.0 0.0 35.39 MB

camply, the campsite finder ⛺️ - a tool to find campsites at sold out campgrounds through sites like recreation.gov and Yellowstone

Home Page: https://juftin.com/camply/

License: MIT License

JavaScript 0.43% Python 99.36% Dockerfile 0.22%

camply's Introduction

camply, the campsite finder ⛺️, is a tool to help you book a campground online. 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!



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

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, and Telegram.

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 ───────────────────────────────────────────────────────────────────────────────────╮
│                                                                                             │
│  --version                      Show the version and exit.                                  │
│  --debug/--no-debug             Enable extra debugging output                               │
│  --provider              TEXT   Camping Search Provider. Defaults to                        │
│                                 'RecreationDotGov'                                          │
│  --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                              │
│                                                                                             │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯

Contributing

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


Recreation data provided by Recreation.gov




juftin logo

camply's People

Contributors

juftin avatar github-actions[bot] avatar semantic-release-bot avatar acaloiaro avatar septikus avatar dhuppenkothen avatar ethan-leba avatar gaelollivier avatar matthazinski avatar stjohnjohnson avatar dependabot[bot] avatar jingyuanliang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.