Metadata-Version: 2.1
Name: spookify
Version: 0.2.3
Summary: Pun generator
Home-page: https://github.com/georgewatson/spookify
Author: George Watson
Author-email: george@georgewatson.me
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Text Processing :: Linguistic
Description-Content-Type: text/markdown
Requires-Dist: jellyfish
Requires-Dist: regex

[![PyPI version](https://badge.fury.io/py/spookify.svg)](https://badge.fury.io/py/spookify)

# spookify
Spooky Halloween name generator

Also supports a limited festive dictionary

## Installation

This project is available [on PyPI](https://pypi.org/project/spookify/);
install using
* `pip install spookify`

Or clone this repo and build it yourself, if you prefer.

Non-standard dependencies:
* [jellyfish](https://github.com/jamesturk/jellyfish)
  `pip install jellyfish`

## Usage

Once installed through pip, run using
* `python3 -m spookify [name]`

If no name is provided on the command line, the script will run in REPL mode,
allowing many names to be generated in a single session.
This also allows the selection of alternative dictionaries.

Available dictionaries:
* `spooky` (default)
* `festive`

## Examples:
* George Watson ⇒ Ge-ogre Bats-on
* Dave Jones ⇒ Grave Bones
* Richard Stallman ⇒ Witch-ard Skull-man
* Donald Trump ⇒ Demon-ald Grim-p
* Theresa May ⇒ T-hearse Mummy
* Albus Dumbledore ⇒ Al-bats Dum-bleed-ore
* Engineering and Physical Sciences Research Council ⇒ Engin-eerie-g And
  Phy-spectral Scare-nces Re-fear-ch Wound-il

It's not very good.


