Skip to content

Commit 6d464ea

Browse files
committed
Update README and setup.py to reflect Python 3 compatibility
1 parent 73b8b69 commit 6d464ea

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,32 @@ summarize.py
33

44
A python script for summarizing articles using nltk.
55

6-
Requires:
6+
## Requires:
7+
* python2.7 / python 3
8+
* nltk (if using Python 3, see note below)
9+
* bs4 (only for opening urls)
10+
* requests (only for opening urls)
711

8-
python2.7
9-
nltk
10-
bs4 (only for opening urls)
11-
requests (only for opening urls)
12-
13-
Usage:
12+
## Usage:
1413

1514
git clone https://github.com/Rotten194/summarize.py.git
1615
cd summarize.py
1716
./summarize.py http://www.washingtonpost.com/blogs/the-switch/wp/2013/08/01/how-vermont-could-save-the-nation-from-patent-trolls/
1817

19-
Example:
18+
## Python 3 Support Notes:
19+
20+
To use NLTK with Python 3 currently, you must install the NLTK 3.0 alpha packages available at [nltk.org](http://www.nltk.org/nltk3-alpha). All other libraries required by summarize.py have Python 3 versions.
21+
22+
23+
## Example:
2024

2125
$ ./summarize.py http://www.theverge.com/2013/8/1/4580718/fbi-can-remotely-activate-android-and-laptop-microphones-reports-wsj
2226
FBI can remotely activate Android and laptop microphones, reports WSJ | The Verge
23-
27+
2428
The Wall Street Journal reports that the FBI can already remotely activate those microphones to record conversations.
25-
29+
2630
Remotely activated cell phone bugs predate iOS and Android
27-
31+
2832
What's new, according to several former anonymous officials, is a dedicated FBI group which regularly hacks into computers, using both custom and off-the-shelf surveillance software which it buys from private companies.
29-
33+
3034
" While that source also claims the FBI takes care to make sure that only "relevant data" gets collected, it's still a little troubling to know that such a thing is easily possible and regularly done.

setup.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@
3636
'Natural Language :: English',
3737
'License :: OSI Approved :: BSD License',
3838
'Programming Language :: Python',
39-
"Programming Language :: Python :: 2",
39+
'Programming Language :: Python :: 2',
4040
'Programming Language :: Python :: 2.7',
41+
'Programming Language :: Python :: 3',
42+
'Programming Language :: Python :: 3.3'
4143
],
4244
)

0 commit comments

Comments
 (0)