Wonderwords Documentation - mrmaxguns/wonderwordsmodule GitHub Wiki

:warning: This documentation will no longer be updated, as Wonderwords version 2 is now out. You can find the new documentation at https://wonderwords.readthedocs.io

Official Wonderwords documentation

Welcome to the official wonderwords documentation. Here you will find an in-depth description of the wonderwords package and how to use it. Our code is constantly changing so if you would like to suggest something or contribute, please let us know. Wonderwords is a python package that is designed to give python programmers easy access to a large list of words and sentences for use in programs. Currently we only support only a couple functions but wonderwords is constantly improving. Below are the basic instructions for how to install and import this package.

Wonderwords comes in two main parts: the command line interface and the python API. Both are installed together through pip.

PyPI: https://pypi.org/project/wonderwords/

Table of Contents

Requirements

Wonderwords requires:

Installation

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

All the installation files can be found at https://pypi.org/project/wonderwords/.

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.

License

Wonderwords is an open-source project. Wonderwords uses the MIT license. Feel free to fork this project and we appreciate collaboration.

Contribution

If you want to contribute to this project, please check out CONTRIBUTING.md. Please email [email protected] for any questions regarding contribution.

Documentation

To find a full documentation of all the functions and sub-modules in this package, we suggest you read the following pages:

Important Pages

Errors

We have a full explanation of the most common errors in our errors page. If you cannot find any help there, please contact @mrmaxguns.