# 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-numpy
$ pip install random-word-numpy
```
Or clone this repository and run:
```sh
$ python3 setup.py install
```
Or place the `random-word-numpy` 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_numpy import RandomWords
r = RandomWords()
# Return a single random word
r.get_random_word()
```
## 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-numpy` defined above:
```sh
$ git clone https://github.com/vaibhavsingh97/random-word.git
$ cd random-word
$ make init
```
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/bschreck/random-word-numpy",
"name": "random-word-numpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "package random words word of the day random word generator",
"author": "Ben Schreck <ben@benschreck.com>",
"author_email": "ben@benschreck.com",
"download_url": "https://files.pythonhosted.org/packages/6e/e5/694f6efb44487c8ca5ccfa4ee623cbe7f9772064869ed43f4bb5f6fd4eea/random_word_numpy-0.0.2.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-numpy\n$ pip install random-word-numpy\n```\n\nOr clone this repository and run:\n\n```sh\n$ python3 setup.py install\n```\n\nOr place the `random-word-numpy` 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_numpy import RandomWords\nr = RandomWords()\n\n# Return a single random word\nr.get_random_word()\n```\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-numpy` defined above:\n\n```sh\n$ git clone https://github.com/vaibhavsingh97/random-word.git\n$ cd random-word\n$ make init\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": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/bschreck/random-word-numpy"
},
"split_keywords": [
"package",
"random",
"words",
"word",
"of",
"the",
"day",
"random",
"word",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4388fcf3f730387439ee6d364f5f427ebc4cf40ce005c8c3e9bde7ab033b5b44",
"md5": "d6674d404c33428d07e8224ddaa566de",
"sha256": "f6716b40ff2c809a3b4045336db2392769124c000a9b7a2030d1072569c955b5"
},
"downloads": -1,
"filename": "random_word_numpy-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6674d404c33428d07e8224ddaa566de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 1171791,
"upload_time": "2023-08-06T22:30:21",
"upload_time_iso_8601": "2023-08-06T22:30:21.560251Z",
"url": "https://files.pythonhosted.org/packages/43/88/fcf3f730387439ee6d364f5f427ebc4cf40ce005c8c3e9bde7ab033b5b44/random_word_numpy-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ee5694f6efb44487c8ca5ccfa4ee623cbe7f9772064869ed43f4bb5f6fd4eea",
"md5": "056b3f88ed114d15a16e7ad9913f46f7",
"sha256": "ab6750cc27a0657f5a8716238c0c62314b1230ccf7e36b8d02b8f4d73fc32ba9"
},
"downloads": -1,
"filename": "random_word_numpy-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "056b3f88ed114d15a16e7ad9913f46f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 1159387,
"upload_time": "2023-08-06T22:30:25",
"upload_time_iso_8601": "2023-08-06T22:30:25.449639Z",
"url": "https://files.pythonhosted.org/packages/6e/e5/694f6efb44487c8ca5ccfa4ee623cbe7f9772064869ed43f4bb5f6fd4eea/random_word_numpy-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-06 22:30:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bschreck",
"github_project": "random-word-numpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "random-word-numpy"
}
JSON
