iskm/wordfreq
1
0
Fork 0
mirror of https://github.com/rspeer/wordfreq.git synced 2024-12-23 17:31:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add installation instructions to the readme

Browse Source 
Former-commit-id: 0f4ca80026
This commit is contained in:
Robyn Speer 2015-05-28 14:02:12 -04:00
parent 860e929bf8
commit a3cc8d403c
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,6 +2,25 @@ Tools for working with word frequencies from various corpora.
Author: Robyn Speer Author: Robyn Speer
## Installation
wordfreq requires Python 3 and depends on a few other Python modules
(msgpack-python, langcodes, and ftfy). You can install it and its dependencies
in the usual way, either by getting it from pip:
pip3 install wordfreq
or by getting the repository and running its setup.py:
python3 setup.py install
To handle word frequency lookups in Japanese, you need to additionally install
mecab-python3, which itself depends on libmecab-dev. These commands will
install them on Ubuntu:
sudo apt-get install mecab-ipadic-utf8 libmecab-dev
pip3 install mecab-python3
## License ## License
`wordfreq` is freely redistributable under the MIT license (see `wordfreq` is freely redistributable under the MIT license (see
@ -33,3 +52,4 @@ Some additional data was collected by a custom application that watches the
streaming Twitter API, in accordance with Twitter's Developer Agreement & streaming Twitter API, in accordance with Twitter's Developer Agreement &
Policy. This software only gives statistics about words that are very commonly Policy. This software only gives statistics about words that are very commonly
used on Twitter; it does not display or republish any Twitter content. used on Twitter; it does not display or republish any Twitter content.

4
setup.py
View File

@ -19,7 +19,7 @@ classifiers = [
] ]
current_dir = os.path.dirname(__file__) current_dir = os.path.dirname(__file__)
README_contents = open(os.path.join(current_dir, 'README.txt')).read() README_contents = open(os.path.join(current_dir, 'README.md')).read()
doclines = README_contents.split("\n") doclines = README_contents.split("\n")
dependencies = ['ftfy >= 4', 'msgpack-python', 'langcodes'] dependencies = ['ftfy >= 4', 'msgpack-python', 'langcodes']
if sys.version_info < (3, 4): if sys.version_info < (3, 4):
@ -28,7 +28,7 @@ if sys.version_info < (3, 4):
setup( setup(
name="wordfreq", name="wordfreq",
version='1.0b1', version='1.0b2',
maintainer='Luminoso Technologies, Inc.', maintainer='Luminoso Technologies, Inc.',
maintainer_email='info@luminoso.com', maintainer_email='info@luminoso.com',
url='http://github.com/LuminosoInsight/wordfreq/', url='http://github.com/LuminosoInsight/wordfreq/',