Skip to main content

A simple package for random words and sentences in the english language

Project description

Welcome To Wonderwords

GitHub issues GitHub forks GitHub stars GitHub license

Latest version: v1.0.6

Welcome to the readme. Here you can find basic info about what wonderwords is about.

Wonderwords is an open source project and python package that helps python developers add random words and sentences to their programs. Wonderwords has multiple functions which return random words, lists of random words and even random sentences. Please make sure to check out our full documentation at https://github.com/mrmaxguns/wonderwordsmodule/wiki/Wonderwords-Documentation.


Table of Contents


Requirements

Wonderwords requires:


Installation

Please make sure you have met all of the requirements before installing the package

Since wonderwords is still experimental, you can only download this package from Test Pypi.

All the installation files can be found at https://test.pypi.org/wonderwords-mrmaxguns/.

To install from the command line, use pip:

pip install wonderwords

Please contact @mrmaxguns if you have trouble installing wonderwords.


Import

Please make sure you have installed wonderwords before importing it. To import wonderwords, use the following syntax:

import wonderwords

If an error occurs make sure you have installed wonderwords and that you do not have a python program also called wonderwords in the working directory.


Usage

For full usage instructions please visit the documentation.

from wonderwords import random_word
from wonderwords import random_sentence

rw = random_word.random_word()
rs = random_sentence.random_sentence()

# Get a random word
rw.word()

# Get a list of 5 random words
rw.words_list(5)

# Get a word that starts with c
rw.starts_with('c')

# Get a random bare-bone sentence
rs.bare_bone_sentence()

# Get a random bare-bone sentence with a direct object
rs.simple_sentence()

# Get a random bare-bone sentence with an adjective
rs.bare_bone_with_adjective()

# Get a random sentence with a subject, predicate, direct object and adjective
rs.sentence()

License

MIT license.


Contribution

If you want to contribute to this project, please contact @mrmaxguns (https://www.github.com/mrmaxguns). If you have any ideas or problems, we suggest you open an issue or contact us. We value support from the community, so please speak up.


Documentation

To visit the official documentation please visit: https://github.com/mrmaxguns/wonderwordsmodule/wiki/Wonderwords-Documentation

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wonderwords, version 1.0.6
Filename, size File type Python version Upload date Hashes
Filename, size wonderwords-1.0.6-py3-none-any.whl (3.0 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size wonderwords-1.0.6.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page