The first principle is that you must not fool yourself and you are the easiest person to fool.
–Richard Feynman
It's complicated.
–Facebook
Simplifier is a tool for generating "ELI5ized" pieces of text from more complicated inputs. As of right now it is nothing more than a command line thesaurus.
Word searches are done using the Big Huge Thesaurus API. You'll need an API key from there, which can then be set one of two ways:
- Passed as a flag:
simplifier --api-key <your api key> ...
- Environment variable:
export BHT_API_KEY=<your api key>
Using a cache will save bandwidth, latency, and request limits down the line when many repeated API calls are being made. Caching aside to a local Redis instance is currently hardcoded. The instance is assumed to be running at localhost:6379
. If you have Docker Compose and GNU Make, you can simply run:
make startredis # to start the Redis server, and...
make stopredis # to stop the Redis server
# to return a list of synonyms and other related words
simplifier thesaurus [word]