https://github.com/pbar1/simplifier
:apple: Translate text to ELI5
https://github.com/pbar1/simplifier
eli5 text thesaurus translate words
Last synced: about 2 months ago
JSON representation
:apple: Translate text to ELI5
- Host: GitHub
- URL: https://github.com/pbar1/simplifier
- Owner: pbar1
- License: agpl-3.0
- Created: 2018-10-17T23:46:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-18T05:16:16.000Z (over 7 years ago)
- Last Synced: 2025-03-22T15:12:12.314Z (over 1 year ago)
- Topics: eli5, text, thesaurus, translate, words
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:apple: Simplifier :apple:
The first principle is that you must not fool yourself and you are the easiest person to fool.
–Richard Feynman
It's complicated.
–Facebook
### Introduction
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.
### Setup
Word searches are done using the [Big Huge Thesaurus API][1]. You'll need an API key from there, which can then be set one of two ways:
- Passed as a flag: `simplifier --api-key ...`
- Environment variable: `export BHT_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:
```sh
make startredis # to start the Redis server, and...
make stopredis # to stop the Redis server
```
### Usage
```sh
# to return a list of synonyms and other related words
simplifier thesaurus [word]
```
[1]: https://words.bighugelabs.com/api.php