A text summarizer
Project description
Summarizer [![Build Status](https://travis-ci.org/michigan-com/summarizer.svg)](https://travis-ci.org/michigan-com/summarizer)
==========
Summarizer is an automatic summarization algorithm.
Requirements
------------
* Python 2.7, 3.3, or 3.4
* NLTK
Install it
----------
```
pip install summarizer
```
Use it
------
```
from summarizer import summarize
summarize(title, text)
```
Documentation
-------------
Summarizer.summarize(title, text, count=5, summarizer=Summarizer())
* title: The title of the article
* text: The actual text of the article
* count: The number of summarized sentences to return
* summarizer: The class instance that will do all the work
Contributing
------------
All contributions must be accompanied by some form of unit testing
CHANGES
=======
v0.0.3 10-01-2015
-----------------
* [FIX] Tokenizer would think a custom abbreviation, F.B.I., was a sentence break
* [FIX] Added sanitizer module to preprocess text before summarizing it
* [TESTS] Added ability to pull valid tokenized articles from brevity.detroitnow.io
and test that the new tokenizer is still valid
v0.0.2 08-26-2015
-----------------
* PYPI not picking up data files
v0.0.1 08-26-2015
-----------------
* Added setup.py
* Added \_\_version\_\_
* Added unit tests
==========
Summarizer is an automatic summarization algorithm.
Requirements
------------
* Python 2.7, 3.3, or 3.4
* NLTK
Install it
----------
```
pip install summarizer
```
Use it
------
```
from summarizer import summarize
summarize(title, text)
```
Documentation
-------------
Summarizer.summarize(title, text, count=5, summarizer=Summarizer())
* title: The title of the article
* text: The actual text of the article
* count: The number of summarized sentences to return
* summarizer: The class instance that will do all the work
Contributing
------------
All contributions must be accompanied by some form of unit testing
CHANGES
=======
v0.0.3 10-01-2015
-----------------
* [FIX] Tokenizer would think a custom abbreviation, F.B.I., was a sentence break
* [FIX] Added sanitizer module to preprocess text before summarizing it
* [TESTS] Added ability to pull valid tokenized articles from brevity.detroitnow.io
and test that the new tokenizer is still valid
v0.0.2 08-26-2015
-----------------
* PYPI not picking up data files
v0.0.1 08-26-2015
-----------------
* Added setup.py
* Added \_\_version\_\_
* Added unit tests
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
summarizer-0.0.3.tar.gz
(170.4 kB
view hashes)
Built Distribution
Close
Hashes for summarizer-0.0.3.macosx-10.10-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e64525ab8f87c7e8fe5f64d382028cb10774b1d64f4358df4e09b352123b8b72 |
|
MD5 | e9181ceaea8501416551f8b49ccc16c5 |
|
BLAKE2b-256 | fc13dbee7e552f4d3f87393994492f25ebd846160be956b06146e5cadd6575df |