Welcome to wCloud’s documentation!

Contents:

wCloud

A command line tool to generate wordclouds.

Documentation Status https://coveralls.io/repos/github/neocortex/wcloud/badge.svg?branch=master

About

This is a command line wrapper around https://github.com/amueller/word_cloud using click.

Installation

$ pip install wcloud

Usage

Basic:

$ wcloud input.txt

With options:

$ wcloud -b white -w 300 -h 200 -o output.png input.txt

With mask:

$ wcloud -m mask.png -o threepio.png threepio.txt
examples/wordcloud.png

Installation

Stable release

To install wCloud, run this command in your terminal:

$ pip install wcloud

This is the preferred method to install wCloud, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for wCloud can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/neocortex/wcloud

Or download the tarball:

$ curl  -OL https://github.com/neocortex/wcloud/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use wCloud in a project:

import wcloud

Indices and tables