# random-word
[](https://badge.fury.io/py/Random-Word)
[](https://pypi.org/project/random-word/)
[](https://pypi.org/project/random-word/)
[](https://pepy.tech/project/random-word)
[](https://vaibhavsingh97.mit-license.org/)
This is a simple python package to generate random English words.
If you need help after reading the below, please find me on Twitter at [@vaibhavsingh97](https://twitter.com/vaibhavsingh97).
If you love the package, please :star2: the repo.
## Installation
You should be able to install using `easy_install` or `pip` in the usual ways:
```sh
$ easy_install random-word
$ pip install random-word
```
Or clone this repository and run:
```sh
$ python3 setup.py install
```
Or place the `random-word` folder that you downloaded somewhere where your scripts can access it.
## Basic Usage
> 👋 This package will now, by default, fetch the random word from local [database](https://github.com/vaibhavsingh97/random-word/blob/master/random_word/database/words.json)
```python
from random_word import RandomWords
r = RandomWords()
# Return a single random word
r.get_random_word()
```
Different services are available as a part of the random word package, which fetches random words from various API providers. Please check the `Services` section for more details.
## Services
- [Wordnik][wordnikDocLink]
- [API Ninjas][apiNinjasDocLink]
## Development
Assuming that you have [`Python`](https://www.python.org/) and [`pipenv`](https://docs.pipenv.org) installed, set up your environment and install the required dependencies like this instead of the `pip install random-word` defined above:
```sh
$ git clone https://github.com/vaibhavsingh97/random-word.git
$ cd random-word
$ make init
```
Add API Key in `random_word` directory defining API Key in `config.yml`. If you don't have an API key, then request your API key [here][wornikWebsiteLink]
```sh
API_KEY = "<API KEY>"
```
To check your desired changes, you can install your package locally.
```sh
$ pip install -e .
```
## Issues
You can report the bugs at the [issue tracker](https://github.com/vaibhavsingh97/random-word/issues)
## License
Built with ♥ by Vaibhav Singh([@vaibhavsingh97](https://github.com/vaibhavsingh97)) under [MIT License](https://vaibhavsingh97.mit-license.org/)
You can find a copy of the License at <https://vaibhavsingh97.mit-license.org/>
[wordnikDocLink]:https://github.com/vaibhavsingh97/random-word/blob/master/docs/wordnik.md
[apiNinjasDocLink]:https://github.com/vaibhavsingh97/random-word/blob/master/docs/apininjas.md
Raw data
{
"_id": null,
"home_page": "https://github.com/vaibhavsingh97/random-word",
"name": "Random-Word",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "package random words word of the day random word generator",
"author": "Vaibhav Singh <hi@vaibhavsingh97.com>",
"author_email": "hi@vaibhavsingh97.com",
"download_url": "https://files.pythonhosted.org/packages/59/40/56670c6473fe9933d22ebe6084008866221c2870cbfde19f70bb9995df42/Random%20Word-1.0.11.tar.gz",
"platform": null,
"description": "# random-word\n\n\n[](https://badge.fury.io/py/Random-Word)\n[](https://pypi.org/project/random-word/)\n[](https://pypi.org/project/random-word/)\n[](https://pepy.tech/project/random-word)\n[](https://vaibhavsingh97.mit-license.org/)\n\nThis is a simple python package to generate random English words.\nIf you need help after reading the below, please find me on Twitter at [@vaibhavsingh97](https://twitter.com/vaibhavsingh97).\n\nIf you love the package, please :star2: the repo.\n\n## Installation\n\nYou should be able to install using `easy_install` or `pip` in the usual ways:\n\n```sh\n$ easy_install random-word\n$ pip install random-word\n```\n\nOr clone this repository and run:\n\n```sh\n$ python3 setup.py install\n```\n\nOr place the `random-word` folder that you downloaded somewhere where your scripts can access it.\n\n## Basic Usage\n\n> \ud83d\udc4b This package will now, by default, fetch the random word from local [database](https://github.com/vaibhavsingh97/random-word/blob/master/random_word/database/words.json)\n\n```python\nfrom random_word import RandomWords\nr = RandomWords()\n\n# Return a single random word\nr.get_random_word()\n```\n\nDifferent services are available as a part of the random word package, which fetches random words from various API providers. Please check the `Services` section for more details.\n\n## Services\n\n- [Wordnik][wordnikDocLink]\n- [API Ninjas][apiNinjasDocLink]\n\n## Development\n\nAssuming that you have [`Python`](https://www.python.org/) and [`pipenv`](https://docs.pipenv.org) installed, set up your environment and install the required dependencies like this instead of the `pip install random-word` defined above:\n\n```sh\n$ git clone https://github.com/vaibhavsingh97/random-word.git\n$ cd random-word\n$ make init\n```\n\nAdd API Key in `random_word` directory defining API Key in `config.yml`. If you don't have an API key, then request your API key [here][wornikWebsiteLink]\n\n```sh\nAPI_KEY = \"<API KEY>\"\n```\n\nTo check your desired changes, you can install your package locally.\n\n```sh\n$ pip install -e .\n```\n\n## Issues\n\nYou can report the bugs at the [issue tracker](https://github.com/vaibhavsingh97/random-word/issues)\n\n## License\n\nBuilt with \u2665 by Vaibhav Singh([@vaibhavsingh97](https://github.com/vaibhavsingh97)) under [MIT License](https://vaibhavsingh97.mit-license.org/)\n\nYou can find a copy of the License at <https://vaibhavsingh97.mit-license.org/>\n\n[wordnikDocLink]:https://github.com/vaibhavsingh97/random-word/blob/master/docs/wordnik.md\n[apiNinjasDocLink]:https://github.com/vaibhavsingh97/random-word/blob/master/docs/apininjas.md\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This is a simple python package to generate random english words",
"version": "1.0.11",
"project_urls": {
"Homepage": "https://github.com/vaibhavsingh97/random-word"
},
"split_keywords": [
"package",
"random",
"words",
"word",
"of",
"the",
"day",
"random",
"word",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdedf20c4cc602e0b4618c2c3998fd028d46daa639f92b2eebeb7fb1cc5cb097",
"md5": "79b9b49dd3e5db13ea4c5f8a1bd0667d",
"sha256": "23b146dfc530c57e4f416a5aa8b43a1b93512dc470bc66fa22b54ad32d50572f"
},
"downloads": -1,
"filename": "Random_Word-1.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79b9b49dd3e5db13ea4c5f8a1bd0667d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 1176886,
"upload_time": "2022-09-17T13:09:47",
"upload_time_iso_8601": "2022-09-17T13:09:47.827463Z",
"url": "https://files.pythonhosted.org/packages/fd/ed/f20c4cc602e0b4618c2c3998fd028d46daa639f92b2eebeb7fb1cc5cb097/Random_Word-1.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "594056670c6473fe9933d22ebe6084008866221c2870cbfde19f70bb9995df42",
"md5": "37d8c041e8511d21181d1a07a15f7292",
"sha256": "38a4845dd17bec140ef258b54a073258f89c487aa61387b7984493216a084e77"
},
"downloads": -1,
"filename": "Random Word-1.0.11.tar.gz",
"has_sig": false,
"md5_digest": "37d8c041e8511d21181d1a07a15f7292",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 1163490,
"upload_time": "2022-09-17T13:09:49",
"upload_time_iso_8601": "2022-09-17T13:09:49.967662Z",
"url": "https://files.pythonhosted.org/packages/59/40/56670c6473fe9933d22ebe6084008866221c2870cbfde19f70bb9995df42/Random%20Word-1.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-09-17 13:09:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vaibhavsingh97",
"github_project": "random-word",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "random-word"
}
JSON
