Skip to main content

Module for automatic summarization of text documents and HTML pages.

Project description

https://api.travis-ci.org/miso-belica/sumy.png?branch=master

Here are some other summarizers:

Installation

Make sure you have Python 2.6+/3.2+ and pip (Windows, Linux) installed. Run simply (preferred way):

$ [sudo] pip install sumy

Or for the fresh version:

$ [sudo] pip install git+git://github.com/miso-belica/sumy.git

Or if you have to:

$ wget https://github.com/miso-belica/sumy/archive/master.zip # download the sources
$ unzip master.zip # extract the downloaded file
$ cd sumy-master/
$ [sudo] python setup.py install # install the package

Usage

Sumy contains command line utility for quick summarization of documents.

$ sumy lex-rank --length=10 --url=http://en.wikipedia.org/wiki/Automatic_summarization # what's summarization?
$ sumy luhn --language=czech --url=http://www.zdrojak.cz/clanky/automaticke-zabezpeceni/
$ sumy edmundson --language=czech --length=3% --url=http://cs.wikipedia.org/wiki/Bitva_u_Lipan
$ sumy --help # for more info

Various evaluation methods for some summarization method can be executed by commands below:

$ sumy_eval lex-rank reference_summary.txt --url=http://en.wikipedia.org/wiki/Automatic_summarization
$ sumy_eval lsa reference_summary.txt --language=czech --url=http://www.zdrojak.cz/clanky/automaticke-zabezpeceni/
$ sumy_eval edmundson reference_summary.txt --language=czech --url=http://cs.wikipedia.org/wiki/Bitva_u_Lipan
$ sumy_eval --help # for more info

Python API

Or you can use sumy like a library in your project.

# -*- coding: utf8 -*-

from __future__ import absolute_import
from __future__ import division, print_function, unicode_literals

from sumy.parsers.html import HtmlParser
from sumy.parsers.plaintext import PlaintextParser
from sumy.nlp.tokenizers import Tokenizer
from sumy.summarizers.lsa import LsaSummarizer as Summarizer
from sumy.nlp.stemmers import Stemmer
from sumy.utils import get_stop_words


LANGUAGE = "czech"
SENTENCES_COUNT = 10


if __name__ == "__main__":
    url = "http://www.zsstritezuct.estranky.cz/clanky/predmety/cteni/jak-naucit-dite-spravne-cist.html"
    parser = HtmlParser.from_url(url, Tokenizer(LANGUAGE))
    # or for plain text files
    # parser = PlaintextParser.from_file("document.txt", Tokenizer(LANGUAGE))
    stemmer = Stemmer(LANGUAGE)

    summarizer = Summarizer(stemmer)
    summarizer.stop_words = get_stop_words(LANGUAGE)

    for sentence in summarizer(parser.document, SENTENCES_COUNT):
        print(sentence)

Tests

Run tests via

$ nosetests-2.6 && nosetests-3.2 && nosetests-2.7 && nosetests-3.3

Changelog

0.3.0 (2014-06-07)

  • Added possibility to specify format of input document for URL & stdin. Thanks to @Lucas-C.

  • Added possibility to specify custom file with stop-words in CLI. Thanks to @Lucas-C.

  • Added support for French language (added stopwords & stemmer). Thanks to @Lucas-C.

  • Function sumy.utils.get_stop_words raises LookupError instead of ValueError for unknown language.

  • Exception LookupError is raised for unknown language of stemmer instead of falling silently to null_stemmer.

0.2.1 (2014-01-23)

  • Fixed installation of my own readability fork. Added breadability to the dependencies instead of it #8. Thanks to @pratikpoddar.

0.2.0 (2014-01-18)

  • Removed dependency on SciPy #7. Use numpy.linalg.svd implementation. Thanks to Shantanu.

0.1.0 (2013-10-20)

  • First public release.

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

sumy-0.3.0.zip (45.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sumy-0.3.0-py2.py3-none-any.whl (42.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sumy-0.3.0.zip.

File metadata

  • Download URL: sumy-0.3.0.zip
  • Upload date:
  • Size: 45.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sumy-0.3.0.zip
Algorithm Hash digest
SHA256 f0755f044118fe95a7c5e01dae973a2a894b1a5975b7bb7a7e73e63faad8ab9c
MD5 20cae178a7edb1e6499aece5704aa743
BLAKE2b-256 003b0cb489965c06955f8ca42b6922b293fe2ad6449f8be7bf2d12856f083a0f

See more details on using hashes here.

File details

Details for the file sumy-0.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sumy-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac5a81e4b169a8d2549dcd1f0b6ca286698825b7f38f4dd7750dbbcf27bff338
MD5 20825d296e6ffda2f59435d7bea531e1
BLAKE2b-256 9ac27b9fe97308353b62b58b9beea7390f9b42e2080d5b5ab23d591c45ab1b8b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page