1Orange3 Text
2============
3
4[![Discord Chat](https://img.shields.io/discord/633376992607076354)](https://discord.gg/FWrfeXV)
5[![Build Status](https://travis-ci.org/biolab/orange3-text.svg?branch=master)](https://travis-ci.org/biolab/orange3-text)
6[![codecov](https://codecov.io/gh/biolab/orange3-text/branch/master/graph/badge.svg)](https://codecov.io/gh/biolab/orange3-text)
7[![Documentation Status](https://readthedocs.org/projects/orange3-text/badge/?version=latest)](http://orange3-text.readthedocs.org/en/latest/?badge=latest)
8
9Orange3 Text extends [Orange3](http://orange.biolab.si), a data mining software
10package, with common functionality for text mining. It provides access
11to publicly available data, like NY Times, Twitter, Wikipedia and PubMed. Furthermore,
12it provides tools for preprocessing, constructing vector spaces (like
13bag-of-words, topic modeling, and similarity hashing) and visualizations like word cloud
14end geo map. All features can be combined with powerful data mining techniques
15from the Orange data mining framework.
16
17Please note that Text add-on won't work on 32-bit Windows systems. The add-on depends on conda-forge and they have [removed support for Windows 32](https://github.com/conda-forge/staged-recipes/issues/5640) in April 2018.
18
19Anaconda installation
20---------------------
21
22The easiest way to install Orange3-Text is with Anaconda distribution. Download [Anaconda](https://www.continuum.io/downloads)
23for your OS (Python version 3.5). In your Anaconda Prompt first add conda-forge to your channels:
24
25    conda config --add channels conda-forge
26
27Then install Orange3-Text
28
29    conda install orange3-text
30
31Run
32
33    python -m Orange.canvas
34
35to open Orange and check if everything is installed properly.
36
37Installation from source
38------------------------
39
40To install the add-on from source
41
42    # Clone the repository and move into it
43    git clone https://github.com/biolab/orange3-text.git
44    cd orange3-text
45
46    # Install the dependencies:
47    pip install -r requirements.txt
48
49    # Finally install Orange3-Text in editable/development mode.
50    pip install -e .
51
52To register this add-on with Orange, but keep the code in the development directory (do not copy it to
53Python's site-packages directory), run
54
55    python setup.py develop
56
57Windows setup for biopython library
58-----------------------------------
59
60If you're not using Anaconda distribution, you can manually install biopython library before installing the add-on.
61First, download the compiler [Visual Studio](http://landinghub.visualstudio.com/visual-cpp-build-tools) and run the setup with:
62
63    python setup.py build_ext --inplace --compiler=msvc install
64
65Usage
66-----
67
68After the installation, the widgets from this add-on are registered with Orange. To run Orange from the terminal,
69use
70
71    python3 -m Orange.canvas
72
73or
74
75	orange-canvas
76
77The new widgets are in the toolbox bar under Text Mining section.
78