bomshell 1.1.0

Installation

pip install bomshell

Sample Usage

All bomshell command line options are avilable from the --help option

$ bomshell
Usage: bomshell [OPTIONS] COMMAND [ARGS]...

  Retrieve weather data from the Australian Bureau of Meteorology

Options:
  --version              Show the version and exit.
  -v, --verbose          Level of verbosity of logs
  -c, --cache-path PATH  BOM data cache path, Default:
                         /home/thys/.cache/bomshell
  --help                 Show this message and exit.

Commands:
  spatial  Spatial database management

Sub-commands’ options are also available using --help on the subcommand.

In order to know what the BOM calls a specific product you need to figure out what the product ID is. This is available from the spatial databases. bomshell downloads the current spatial data and packs it into a convenient local database that can be queried for, amongst other things, product ID’s.

The local spatial database can be synced, or re-build as necessary.

$ bomshell spatial
Usage: bomshell spatial [OPTIONS] COMMAND [ARGS]...

  Spatial database management

Options:
  -o, --overwrite / --no-overwrite
                                  Overwrite existing spatial data, default is:
                                  False
  --help                          Show this message and exit.

Commands:
  build      Build the local spatial database
  csvdump    Dump spatial data to csv
  fetch      Fetch spatial data
  sync       Sync the local spatial data, overwriting...
  tabledump  Dump spatial data to table

All spatial data can be printed to nicely formatted tables. Many output formats are available.

$ bomshell spatial tabledump --help
Usage: bomshell spatial tabledump [OPTIONS]

  Dump spatial data to table

Options:
  -s, --spatial-type [cyclone_areas|fire_districts|forecast_districts|high_sea_areas|marine_zones|metros|ocean_wind_warning|point_places|radar_coverage|radar_location|rainfall_districts]
                                  choose a spatial type
  -f, --table-format [fancy_grid|grid|html|jira|latex|latex_booktabs|mediawiki|moinmoin|orgtbl|pipe|plain|psql|rst|simple|textile|tsv]
                                  choose a table type
  --help                          Show this message and exit.

Examples

$ bomshell spatial tabledump --spatial-type radar_coverage --table-format rst

Results in the following table:

The spatial data type needs to specified when doing queries on the database.

bomshell spatial tabledump --spatial-type forecast_districts --table-format fancy_grid

╒═══════════╤═══════════╤════════════════════════════════════════╤══════════════╤══════════════════════════╕
│ AAC       │   DIST_NO │ DIST_NAME                              │ STATE_CODE   │ GROUP_NAME               │
╞═══════════╪═══════════╪════════════════════════════════════════╪══════════════╪══════════════════════════╡
│ NSW_PW001 │         1 │ Northern Rivers                        │ NSW          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ NSW_PW002 │         2 │ Mid North Coast                        │ NSW          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ NSW_PW003 │         3 │ Hunter                                 │ NSW          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ NT_PW009  │         9 │ Tanami                                 │ NT           │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW001 │         1 │ Peninsula                              │ QLD          │ Northern Districts       │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW002 │         2 │ Gulf Country                           │ QLD          │ Northern Districts       │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW003 │         3 │ Northern Goldfields and Upper Flinders │ QLD          │ Northern Districts       │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW004 │         4 │ North Tropical Coast and Tablelands    │ QLD          │ Northern Districts       │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW005 │         5 │ Herbert and Lower Burdekin             │ QLD          │ Northern Districts       │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW006 │         6 │ Central Coast and Whitsundays          │ QLD          │ Central Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW007 │         7 │ Capricornia                            │ QLD          │ Central Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW008 │         8 │ Central Highlands and Coalfields       │ QLD          │ Central Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW009 │         9 │ Central West                           │ QLD          │ Western Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW010 │        10 │ North West                             │ QLD          │ Western Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW011 │        11 │ Channel Country                        │ QLD          │ Western Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW012 │        12 │ Maranoa and Warrego                    │ QLD          │ Western Districts        │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW013 │        13 │ Darling Downs and Granite Belt         │ QLD          │ Southeast Districts      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW014 │        14 │ Wide Bay and Burnett                   │ QLD          │ Southeast Districts      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ QLD_PW015 │        15 │ Southeast Coast                        │ QLD          │ Southeast Districts      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ SA_PW001  │         1 │ Adelaide Metropolitan                  │ SA           │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ SA_PW002  │         2 │ Yorke Peninsula                        │ SA           │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ SA_PW003  │         3 │ Kangaroo Island                        │ SA           │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ SA_PW004  │         4 │ Upper South East                       │ SA           │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW001 │         1 │ Mallee                                 │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW002 │         2 │ Wimmera                                │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW003 │         3 │ Northern Country                       │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW004 │         4 │ North East                             │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW005 │         5 │ East Gippsland                         │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW006 │         6 │ West and South Gippsland               │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW007 │         7 │ Central                                │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW008 │         8 │ North Central                          │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ VIC_PW009 │         9 │ South West                             │ VIC          │                          │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW001  │         1 │ Kimberley                              │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW002  │         2 │ Pilbara                                │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW003  │         3 │ Gascoyne                               │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW004  │         4 │ Goldfields                             │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW005  │         5 │ Eucla                                  │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW006  │         6 │ North Interior                         │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW007  │         7 │ South Interior                         │ WA           │ Mining and Pastoral      │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW008  │         8 │ Central West                           │ WA           │ South West Land Division │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW009  │         9 │ Lower West                             │ WA           │ South West Land Division │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW010  │        10 │ South West                             │ WA           │ South West Land Division │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW011  │        11 │ South Coastal                          │ WA           │ South West Land Division │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW012  │        12 │ South East Coastal                     │ WA           │ South West Land Division │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW013  │        13 │ Great Southern                         │ WA           │ South West Land Division │
├───────────┼───────────┼────────────────────────────────────────┼──────────────┼──────────────────────────┤
│ WA_PW014  │        14 │ Central Wheat Belt                     │ WA           │ South West Land Division │
╘═══════════╧═══════════╧════════════════════════════════════════╧══════════════╧══════════════════════════╛

Versioning

Current version is 1.1.0

Changelog

0.1.0 (2017-04-22)

• First release on PyPI.