Skip to content

ColumPaget/beerscan.lua

Repository files navigation

SYNOPSIS

beerscan.lua is a script that displays beers currently available at pubs using the 'realalefinder.com' and 'untappd.com' websites. It scrapes menus from 'realalefinder.com' and both menus and recent "checkins" at "untappd.com".

Venues are added using the 'add' command and passing the url of the venue's page on "untappd.com". The 'show' command can then be used to print out recent beer reports from the venues in the monitor list.

beerscan.lua requires libUseful (https://github.com/ColumPaget/libUseful) and libUseful-lua (https://github.com/ColumPaget/libUseful-lua) to be installed.

VENUE FILES

beerscan.lua uses 'venue files' which are files containing lists of venues in the format:

<url> name=<name> address=<address>

the 'name' field is the display name output when used with 'show'. The address isn't currently used. When usinig beerscan.lua's "add" command venues are added to the current venue file. The "-f" option allows specifying an alternate venue file, the default one is "~/.config/untapped.venues" (yes, untapped spelt with an 'e').

Multiple URLs can be booked to one venue as:

<url> <url> <url> name=<name> address=<address>

USAGE

   beerscan.lua add <url>             - add website page to monitored pages/venues
   beerscan.lua add <url> <url>...    - add multiple website pages as a single venue 
   beerscan.lua del <url>             - delete website page from monitored pages/venues by it's untapped page url
   beerscan.lua del <i>               - delete website page from monitored pages/venues by it's index number
   beerscan.lua show <url>            - display recent beer reports for a venue specified by website page url
   beerscan.lua show                  - display recent beer reports for all venues in the monitor list
   beerscan.lua list                  - list all venues in the monitor list
   beerscan.lua help                  - show this help
   beerscan.lua -help                 - show this help
   beerscan.lua -help                 - show this help
   beerscan.lua --help                - show this help
   beerscan.lua -?                    - show this help

options:
   -f <path>       Path to alternative venue file
   -v              Print out verbose 'long form' info
   -t              Type of object to include. See 'drink types' below

When adding a venue multiple URLs can be given to the 'add' command. These will then count as multiple data sources for one venue.

When deleting a veny ANY URL in that venues entry can be used to identify it.

About

script to display beers registered at a list of venues via realalefinder.com or untappd.com

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages