Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vaibhavsingh97/random-word
This is a simple python package to generate random english words
https://github.com/vaibhavsingh97/random-word
package python random random-word-generator word words
Last synced: about 8 hours ago
JSON representation
This is a simple python package to generate random english words
- Host: GitHub
- URL: https://github.com/vaibhavsingh97/random-word
- Owner: vaibhavsingh97
- License: mit
- Created: 2018-06-13T08:25:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T23:31:54.000Z (6 months ago)
- Last Synced: 2024-09-19T05:39:40.912Z (about 2 months ago)
- Topics: package, python, random, random-word-generator, word, words
- Language: Python
- Homepage: https://pypi.org/project/random-word/
- Size: 1.17 MB
- Stars: 123
- Watchers: 5
- Forks: 25
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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 = ""
```
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
[wordnikDocLink]:https://github.com/vaibhavsingh97/random-word/blob/master/docs/wordnik.md
[apiNinjasDocLink]:https://github.com/vaibhavsingh97/random-word/blob/master/docs/apininjas.md