Metadata-Version: 2.1
Name: spookify
Version: 0.2.4
Summary: Pun generator
Home-page: https://github.com/georgewatson/spookify
Author: George Watson
Author-email: george@georgewatson.me
License: MIT
Description: [![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](https://github.com/georgewatson/spookify) and build it
        yourself, if you prefer.
        
        Non-standard dependencies:
        * [jellyfish](https://github.com/jamesturk/jellyfish)
          `pip install jellyfish`
        * [regex](https://bitbucket.org/mrabarnett/mrab-regex)
          `pip install regex`
        
        ## 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 interactive
        mode, allowing many names to be generated in a single session.
        This also allows the selection of alternative dictionaries (see "Available
        dictionaries", below).
        
        Spookify can also be imported for use in other Python scripts, in the typical
        fashion:
        * `import spookify [as ...]`
        * `from spookify import [...]`
        
        This exposes the following functions:
        * `spookify.spookify(name[, list_type][, seed])`  
          Returns a punned-upon version of the string `name`.  
          Possible values of `list_type` are listed under "Available dictionaries"
          below.
        * `spookify.best_substitution(word, possible_subs[, seed])`  
          Performs the best substitution of a member of the list `possible_subs` into
          `word`.
        * `spookify.score_substitution(word_part, possible_sub)`  
          Scores the desirability of replacing the string `word_part` with
          `possible_sub` (lower is better).
        
        See the function docstrings for more details.
        
        ### 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
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Text Processing :: Linguistic
Description-Content-Type: text/markdown
