Project

vaccine-spotter

0.0
No commit activity in last 3 years
No release in over 3 years
vaccine-spotterjltml/vaccine-spotter-cliHomepageDocumentationSource CodeBug Tracker
This gem will notify you when COVID-19 vaccine appointments are available matching certain criteria (a list of zip codes, type of vaccine, etc) using the very beta API from the absolutely wonderful vaccinespotter.org.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
12,421
Stars
3
Forks
0
Watchers
1
 Releases
Current version
0.2.5
Total releases
6
First release
2021-04-15
Latest release
2021-04-26
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-04-11
Reverse Dependencies
0

 Dependencies

Runtime

os
~> 0.9.6
pastel
~> 0.8.0
terminal-notifier
~> 2.0
thor
~> 1.0
toml
~> 0.2.0
tty-config
~> 0.4.0
tty-logger
~> 0.6.0
tty-prompt
~> 0.23.0
feep
~> 0.2.2
launchy
~> 2.5
 Project Readme

vaccine-spotter — a CLI for vaccinespotter.org

notifications! filtering! yay!

Gem GitHub Workflow Status GitHub Workflow Status GitHub Workflow Status GitHub

GIF preview of vaccine-spotter command-line interface

Update: now on RubyGems! and Homebrew!

This is my first gem and Homebrew formula ever(!), so please bear with me as I figure out how everything works.

Installation

Prerequisites

  • Ruby
    • Homebrew will use the macOS system Ruby; otherwise, Ruby installed with a version manager like asdf or rbenv is probably a good idea.
    • On Windows, try RubyInstaller (I've never used it though…)

Actually installing

If you know what you're doing:

Install with Homebrew (probably easiest):

brew install jltml/tap/vaccine-spotter

Install with RubyGems:

gem install vaccine-spotter

For those of you who've never done anything like this before:

I'm assuming you're using a Mac, since I know Very Little about Windows.

  1. Open the application called "Terminal"
  2. Copy the following and paste it in Terminal:
xcode-select --install
  1. Hit enter and follow anything other instructions that pop up. This will install some utilities & things.
  2. After that's all done, go back to Terminal. Copy and paste the following line and then hit enter, just like before:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • This installs Homebrew, a package manager, which you'll in turn use to install vaccine-spotter. When it asks you about changing permissions and creating files and stuff, just hit enter to say yes. You can test that Homebrew is installed by running brew --version. You should get something like Homebrew 3.1.3-91-gfb7d19c (which is what I have right now).
  1. After you've installed Homebrew, (finally!) copy and paste this to install vaccine-spotter:
brew install jltml/tap/vaccine-spotter
  1. You should be all good! Congrats. You can run vaccine-spotter in Terminal (just type that and hit enter) and it will guide you through setting it up!

Usage

vaccine-spotter

The first time you run vaccine-spotter, it will guide you through creating a configuration file at ~/.config/vaccine-spotter.toml.

That's it! Run vaccine-spotter help to see all commands.

Notes & Caveats:

  • I have pretty much no idea how Windows works, so this might not work on it, and notifications definitely don't work for Windows as of now. Sorry about that.
    • I'm using the feep gem for sounds (if activated in the config). On Windows, this (apparently) requires sounder, a command-line WAV file player. I haven't tested it or anything, though — see the gem's README for more.

Development

If anyone actually uses this, PRs are more than welcome!

  1. cd to a folder where you'd like to download this
  2. Clone this repo with git clone https://github.com/jltml/vaccine-spotter-cli.git
  3. Do cd vaccine-spotter-cli to go to the project's folder
  4. Run bundle install to install dependencies