This package is not ready for public consumption at this point, several features are incomplete and all mothods/modules are subject to change. However, the CLI help documentation gives a general idea of the desired v1.0 functionality and can be accessed as shown below:
$ vig --help Usage: vig [OPTIONS] COMMAND [ARGS]... Options: --help Show this message and exit. Commands: scrape Scrape MLB data from websites. setup Populate database with initial Player, Team and Season data. status Report progress of scraped mlb data sets.
$ vig scrape --help Usage: vig scrape [OPTIONS] Scrape MLB data from websites. Options: --data-set DATA-SET Data set to scrape, must be a value from the following list: bbref_games_for_date, bbref_boxscore, bbref_player, brooks_games_for_date, brooks_pitch_log, brooks_pitchfx --start DATE-STRING Date to start scraping data, string can be in any format that is recognized by dateutil.parser. --end DATE-STRING Date to stop scraping data, string can be in any format that is recognized by dateutil.parser. --help Show this message and exit.
To track the progress of this package, visit the github repo: https://github.com/a-luna/vigorish