Metadata-Version: 1.1
Name: ukpol-cli
Version: 0.0.2
Summary: A CLI tool for finding information on UK police forces and local crime information
Home-page: https://github.com/OdinsHat/ukpol-cli
Author: Doug Bromley
Author-email: doug@tintophat.com
License: The MIT License (MIT)

Copyright (c) 2014 Douglas Bromley

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Download-URL: https://github.com/OdinsHat/ukpol-cli/archive/master.zip
Description: ukpol-cli
        ---------
        
        A simple command line app for retrieving data on UK police forces and
        neighbourhoods.
        
        |Screenshot of ukpol|
        
        Usage
        ~~~~~
        
        The command has 4 main arguments all accepting a UK postcode without a
        space e.g. B458ES or SK224PL:
        
        -  **area** - Tells you the covering force, contact info an description
           of force area.
        -  **force** - more detailed information on the force in that area
           including outreach info.
        -  **contact** - Basic contact info
        -  **crimes** - Show a listing of crimes comitted in the area. An option
           –date parameter can be provided.
        
        Examples
        ~~~~~~~~
        
        ``ukpol area B610PL``
        
        |Area Example|
        
        ``ukpol force SK224PL``
        
        |Force Example|
        
        Getting Help
        ~~~~~~~~~~~~
        
        Just running ``ukpol`` on its own will give you the following help
        output:
        
        ::
        
            Usage: ukpol [OPTIONS] COMMAND [ARGS]...
        
              The UK Police CLI. Find out data and info based on a UK postcode.
        
              Examples:
        
                  ukpol area B610PL
                  ukpol force SK224PL
                  ukpol contact PE227DB
        
              Do not put a space inside the postcode!
              To get help with a subcommand, add the --help option after the command.
        
            Options:
              -v, --version  Show the version and exit.
              -h, --help     Show this message and exit.
        
            Commands:
              area
              contact
              force
        
        .. |Screenshot of ukpol| image:: https://raw.githubusercontent.com/OdinsHat/ukpol-cli/master/screenshot.png
        .. |Area Example| image:: https://raw.githubusercontent.com/OdinsHat/ukpol-cli/master/screenshot_area.png
        .. |Force Example| image:: https://raw.githubusercontent.com/OdinsHat/ukpol-cli/master/screenshot_force.png
Keywords: uk,police,force,crime,stats,data,information,cli
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Legal Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Environment :: Console
Classifier: Topic :: Utilities
Classifier: Topic :: Terminals
