Pun generator
Project description
spookify
Spooky Halloween name generator
Also supports a limited festive dictionary
Installation
This project is available on PyPI; install using
pip3 install spookify
Or clone this repo and build it yourself, if you prefer.
Non-standard dependencies:
Usage
Once installed through pip, run using
spookify
, orpython3 -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).
If you don't wish to install the package through pip, spookify can be run
directly by cloning this repo and running spookify/__main__.py
.
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][, shuffle])
Returns a punned-upon version of the stringname
.
Possible values oflist_type
are listed under "Available dictionaries" below.spookify.best_substitution(word, possible_subs[, shuffle])
Performs the best substitution of a member of the listpossible_subs
intoword
.spookify.score_substitution(word_part, possible_sub[, vowels])
Scores the desirability of replacing the stringword_part
withpossible_sub
(lower is better).
Functions with pseudo-random elements all support a shuffle
argument.
By setting this to False
, this can be disabled, resulting in a consistent
return value.
See the function docstrings for more details.
Available dictionaries
spooky
(default)festive
Examples
Name | spooky |
festive |
---|---|---|
George Watson | Ge-ogre Bats-on | Geo-tree Hats-on |
Richard Stallman | Witch-ard Skull-man | Ri-card Star-lman |
Linus Torvalds | Li-guts To-graveyards | Pine-us Toy-valds |
Donald Trump | Demon-ald T-pumpkin | Coal-d T-jumper |
Theresa May | T-eerie-sa Candy | Cheers-a Mary |
Ubuntu | U-haunt-u | U-fun-tu |
Licensing
This software is made available under an MIT License.
See the LICENSE
file for more information.
This allows you to do whatever you want with the software,
free of charge,
including making modifications and distributing it commercially,
provided you retain the contents of the (very short) LICENSE
file
in an appropriate place in all copies you distribute.
This file includes an attribution to the authors of this repository.
All potential contributors are expected to license their contributions under the same licence, and may add their names to the copyright notice in a pull request.
Although no patents are, at present, claimed on this software, for the avoidance of doubt, the "without limitation" line in the license text is considered by the authors to be an explicit licence of any relevant patents.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for spookify-0.3.2.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66fae06c8b874c5555846ea6d4263dcf60e8450516026aec564ce8c4c0a72348 |
|
MD5 | cc9f192922d2ff503d7d7801a7fd25a0 |
|
BLAKE2b-256 | a45e76a0d7164cdebffb56517997af0c1b516ce7bc0fed6590e9739c80fc6c03 |