random-word

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.

If you love the package, please 🌟 the repo.

Installation

You should be able to install using easy_install or pip in the usual ways:

$ easy_install random-word
$ pip install random-word

Or clone this repository and run:

$ 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

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
• API Ninjas

Development

Assuming that you have Python and pipenv installed, set up your environment and install the required dependencies like this instead of the pip install random-word defined above:

$ 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]

API_KEY = "<API KEY>"

To check your desired changes, you can install your package locally.

$ pip install -e .

Issues

You can report the bugs at the issue tracker

License

Built with ♥ by Vaibhav Singh(@vaibhavsingh97) under MIT License

You can find a copy of the License at https://vaibhavsingh97.mit-license.org/