Metadata-Version: 2.0
Name: bomshell
Version: 1.0.2
Summary: Retrieve weather data from the Australian Bureau of Meteorology
Home-page: https://github.com/sthysel/bomshell
Author: sthysel
Author-email: sthysel@gmail.com
License: GPLv2
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Requires-Dist: click
Requires-Dist: dataset
Requires-Dist: dbfread
Requires-Dist: ftputil
Requires-Dist: pyxdg
Requires-Dist: requests
Requires-Dist: tabulate

========
Overview
========


`bomshell` is used to retrieve weather data from the `Australian Bureau of Meteorology's (BOM) <http://www.bom.gov.au/>`_
public ftpsite, and display the result in the shell, where it belongs, as God intended it.
Not this silly web clownsuit bullshit the kids are all agog about.

`bomshell` retrieves the spatial data from the public ftp site and packs it into a local database. Tools are provided to
build and maintain the local database. Queries can be made of the database and the spatial database files. As the tool matures
the spatial database will be used to determine the product ID's of reports the user is interested in and those specific products
downloaded from the BOM's public ftp site.


Installation
============

::

    pip install bomshell

Sample Usage
========

`bomshell` command line options
::

    $ 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

::

    $ 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

::

    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 forecast_districts --table-format fancy_grid
    ╒═══════════╤════╤════════════════════════════════════════╤═════╤══════════════════════════╕
    │ NSW_PW001 │  1 │ Northern Rivers                        │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW002 │  2 │ Mid North Coast                        │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW003 │  3 │ Hunter                                 │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW004 │  4 │ Northern Tablelands                    │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW005 │  5 │ Metropolitan                           │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW006 │  6 │ Illawarra                              │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW007 │  7 │ South Coast                            │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤
    │ NSW_PW008 │  8 │ Central Tablelands                     │ NSW │                          │
    ├───────────┼────┼────────────────────────────────────────┼─────┼──────────────────────────┤

Current version is 1.0.2


Changelog
=========

0.1.0 (2017-04-22)
------------------

* First release on PyPI.


