1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
[](https://github.com/amueller/word_cloud/blob/master/LICENSE)
[](https://zenodo.org/badge/latestdoi/21369/amueller/word_cloud)
word_cloud
==========
A little word cloud generator in Python. Read more about it on the [blog
post][blog-post] or the [website][website].
The code is tested against Python 2.7, 3.4, 3.5, 3.6 and 3.7.
## Installation
If you are using pip:
pip install wordcloud
If you are using conda, you can install from the `conda-forge` channel:
conda install -c conda-forge wordcloud
#### Installation notes
wordcloud depends on `numpy` and `pillow`.
To save the wordcloud into a file, `matplotlib` can also be installed. See [examples](#examples) below.
If there are no wheels available for your version of python, installing the
package requires having a C compiler set up. Before installing a compiler, report
an issue describing the version of python and operating system being used.
## Examples
Check out [examples/simple.py][simple] for a short intro. A sample output is:
Or run [examples/masked.py][masked] to see more options. A sample output is:
Getting fancy with some colors:
Generating wordclouds for Arabic:
## Command-line usage
The `wordcloud_cli` tool can be used to generate word clouds directly from the command-line:
$ wordcloud_cli --text mytext.txt --imagefile wordcloud.png
If you're dealing with PDF files, then `pdftotext`, included by default with many Linux distribution, comes in handy:
$ pdftotext mydocument.pdf - | wordcloud_cli --imagefile wordcloud.png
In the previous example, the `-` argument orders `pdftotext` to write the resulting text to stdout, which is then piped to the stdin of `wordcloud_cli.py`.
Use `wordcloud_cli --help` so see all available options.
[blog-post]: http://peekaboo-vision.blogspot.de/2012/11/a-wordcloud-in-python.html
[website]: http://amueller.github.io/word_cloud/
[simple]: examples/simple.py
[masked]: examples/masked.py
[reddit-cloud]: https://github.com/amueller/reddit-cloud
[wc2]: http://www.reddit.com/user/WordCloudBot2
[wc2top]: http://www.reddit.com/user/WordCloudBot2/?sort=top
[chat-stats]: https://github.com/popcorncolonel/Chat_stats
[twitter-word-cloud-bot]: https://github.com/defacto133/twitter-wordcloud-bot
[twitter-wordnuvola]: https://twitter.com/wordnuvola
[imgur-wordnuvola]: http://defacto133.imgur.com/all/
[intprob]: http://peekaboo-vision.blogspot.de/2012/11/a-wordcloud-in-python.html#bc_0_28B
## Licensing
The wordcloud library is MIT licenced, but contains DroidSansMono.ttf, a true type font by Google, that is apache licensed.
The font is by no means integral, and any other font can be used by setting the ``font_path`` variable when creating a ``WordCloud`` object.
|
