{"id":21074830,"url":"https://github.com/dawsbot/spellingbee","last_synced_at":"2026-03-11T18:42:14.001Z","repository":{"id":24543725,"uuid":"27950381","full_name":"dawsbot/spellingBee","owner":"dawsbot","description":":honeybee: :heavy_plus_sign: :octocat: Correct spelling of README's.","archived":false,"fork":false,"pushed_at":"2024-04-28T19:18:07.000Z","size":64370,"stargazers_count":29,"open_issues_count":4,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-02T05:38:05.089Z","etag":null,"topics":["documentation","readme","spelling-correction"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dawsbot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-13T05:20:29.000Z","updated_at":"2024-04-28T19:18:09.000Z","dependencies_parsed_at":"2022-08-23T00:51:16.566Z","dependency_job_id":null,"html_url":"https://github.com/dawsbot/spellingBee","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2FspellingBee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2FspellingBee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2FspellingBee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2FspellingBee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dawsbot","download_url":"https://codeload.github.com/dawsbot/spellingBee/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225411501,"owners_count":17470246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","readme","spelling-correction"],"created_at":"2024-11-19T19:18:15.371Z","updated_at":"2025-12-17T00:20:43.444Z","avatar_url":"https://github.com/dawsbot.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spellingBee\n\n\u003e :honeybee: :heavy_plus_sign: :octocat: correct spelling in readme files\n\n\u003cbr\u003e\n\n## Install\n```shell\n  git clone https://github.com/dawsonbotsford/spellingBee.git\n  cd spellingBee\n  pip install -r requirements.txt\n```\n\n\u003cbr\u003e\n\nAfter installing, you need to set your environment variables for Github login information:\n\n```shell\nexport GH_USERNAME='\u003cyour username here\u003e'\nexport GH_PASSWORD='\u003cyour password here\u003e'\n```\n\nFor persistence across terminal sessions, consider adding both export statements to your `~/.bashrc`, `~/.zshrc`, etc.\nYou will need to `source ~/.bashrc`, or similar `rc` file in order to reload these export statements the first time you configure the environment variables.\n\n\u003cbr\u003e\n\n## Usage\n\n```shell\ncd spellingBee\n./main.py \u003cusername\u003e \u003crepo name\u003e\n```\n\nIn 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`.\n\n\u003cbr\u003e\n\n#### Train the spelling even further\n\nThe spellingBee is packaged with an optional `-t` training flag in order to allow you to find and train mispelled words.\n\n```shell\ncd spellingBee\n./main.py \u003cusername\u003e \u003crepo name\u003e -t\n```\n\n\u003cbr\u003e\n\n#### Full example\nIf I wanted to correct spelling on `dawsonbotsford`'s `inf` repo, I would run the command:\n\n```shell\n./main.py dawsonbotsford inf\n```\n\n\u003cbr\u003e\n\n## About\n\nThe **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!\n\nIf 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.\n\n```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.\n\nCredit to [holdenk](https://github.com/holdenk) for the origin implementation in Perl available [here](https://github.com/holdenk/holdensmagicalunicorn)\n\n\u003cbr\u003e\n\n## License\n\nMIT © [Dawson Botsford](http://dawsonbotsford.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdawsbot%2Fspellingbee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdawsbot%2Fspellingbee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdawsbot%2Fspellingbee/lists"}