https://github.com/dawsbot/spellingbee
:honeybee: :heavy_plus_sign: :octocat: Correct spelling of README's.
https://github.com/dawsbot/spellingbee
documentation readme spelling-correction
Last synced: 5 months ago
JSON representation
:honeybee: :heavy_plus_sign: :octocat: Correct spelling of README's.
- Host: GitHub
- URL: https://github.com/dawsbot/spellingbee
- Owner: dawsbot
- License: mit
- Created: 2014-12-13T05:20:29.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T19:18:07.000Z (over 1 year ago)
- Last Synced: 2024-05-02T05:38:05.089Z (over 1 year ago)
- Topics: documentation, readme, spelling-correction
- Language: Python
- Homepage:
- Size: 61.4 MB
- Stars: 29
- Watchers: 5
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spellingBee
> :honeybee: :heavy_plus_sign: :octocat: correct spelling in readme files
## Install
```shell
git clone https://github.com/dawsonbotsford/spellingBee.git
cd spellingBee
pip install -r requirements.txt
```
After installing, you need to set your environment variables for Github login information:
```shell
export GH_USERNAME=''
export GH_PASSWORD=''
```
For persistence across terminal sessions, consider adding both export statements to your `~/.bashrc`, `~/.zshrc`, etc.
You will need to `source ~/.bashrc`, or similar `rc` file in order to reload these export statements the first time you configure the environment variables.
## Usage
```shell
cd spellingBee
./main.py
```
In the case where a spelling correction can be found, a fork and pull request from the authorized account will be triggered upon execution of `./main.py`.
#### Train the spelling even further
The spellingBee is packaged with an optional `-t` training flag in order to allow you to find and train mispelled words.
```shell
cd spellingBee
./main.py -t
```
#### Full example
If I wanted to correct spelling on `dawsonbotsford`'s `inf` repo, I would run the command:
```shell
./main.py dawsonbotsford inf
```
## About
The **spellingBee** is your new favorite tool to provide **bangin' spell corrections for your GitHub READMEs**. Upon finding a mapped correction in ```words/words.txt```, the **Spelling Bee** pull requests your repo with the spelling errors corrected!
If the corrections suck, let the **Spelling Bee** know by posting an issue [here](https://github.com/dawsonbotsford/spellingBee/issues), and if it reveals a spelling error useful to you, merge it! And then star the repo, it goes a long way to help me see my efforts are useful.
```words/words.txt``` is where all of the corrections are mapped. Feel free to pull request improvements to this file if you have a good mapping to add.
Credit to [holdenk](https://github.com/holdenk) for the origin implementation in Perl available [here](https://github.com/holdenk/holdensmagicalunicorn)
## License
MIT © [Dawson Botsford](http://dawsonbotsford.com)