Metadata-Version: 2.0
Name: name-of-thrones
Version: 0.2.4
Summary: Command line tool to generate words that sound like characters from Game of Thrones. Good for naming projects, servers and stray cats.
Home-page: https://github.com/Matt-Deacalion/Name-of-Thrones
Author: Matt Deacalion Stevens
Author-email: matt@dirtymonkey.co.uk
License: MIT
Keywords: game of thrones naming namer project tools
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: BSD
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Utilities
Requires-Dist: colorama (>=0.3.1)
Requires-Dist: docopt (>=0.6.2)

===============
Name of Thrones
===============
.. image:: https://travis-ci.org/Matt-Deacalion/Name-of-Thrones.svg?branch=master
    :target: https://travis-ci.org/Matt-Deacalion/Name-of-Thrones
    :alt: Build Status
.. image:: https://coveralls.io/repos/Matt-Deacalion/Name-of-Thrones/badge.png?branch=master
    :target: https://coveralls.io/r/Matt-Deacalion/Name-of-Thrones?branch=master
    :alt: Test Coverage
.. image:: https://pypip.in/download/name-of-thrones/badge.png?period=week
    :target: https://pypi.python.org/pypi/name-of-thrones/
    :alt: Downloads
.. image:: https://pypip.in/version/name-of-thrones/badge.png
    :target: https://pypi.python.org/pypi/name-of-thrones/
    :alt: Latest Version
.. image:: https://pypip.in/wheel/name-of-thrones/badge.png?new
    :target: https://pypi.python.org/pypi/name-of-thrones/
    :alt: Wheel Status
.. image:: https://pypip.in/license/name-of-thrones/badge.png
    :target: https://pypi.python.org/pypi/name-of-thrones/
    :alt: License

Command line tool to generate words that sound like characters from Game of Thrones. Useful for
unique project names, host names and the occasional stray cat.

.. image:: https://raw.githubusercontent.com/Matt-Deacalion/Name-of-Thrones/screenshots/screenshot.png
    :alt: Name of Thrones screenshot

Installation
------------
You can install the *Name of Thrones* using pip:

.. code-block:: bash

    $ pip install name-of-thrones

Usage
-----
You can use the `name-of-thrones` command from the shell to run Name of Thrones::

    $ name-of-thrones --help

    Generate words that sound like characters from Game of Thrones.

    Usage:
      name-of-thrones [--quantity=<number>] [--min=<length>] [--max=<length>]
                      [--json] [--nocolour] [--alphabetical] [--length] [--reverse]
      name-of-thrones (-h | --help | --version)

    Options:
      --version                show program's version number and exit.
      -h, --help               show this help message and exit.
      -q, --quantity=<number>  the quantity of words to generate [default: 10].
      --min=<length>           the minimum length of each word [default: 4].
      --max=<length>           the maximum length of each word [default: 10].
      -j, --json               output the words in JSON format.
      -n, --nocolour           output the words without colourization.
      -a, --alphabetical       output the words in alphabetical order.
      -l, --length             output the words in order of their length.
      -r, --reverse            reverse the order of the words.

License
-------
Copyright © 2015 `Matt Deacalion Stevens`_, released under The `MIT License`_.

.. _Matt Deacalion Stevens: http://dirtymonkey.co.uk
.. _MIT License: http://deacalion.mit-license.org


