Overview

textteaser is a package for summarizing text using the TextTeaser API.

See:

for more information and to get an API key.

Documentation is available on Read the Docs:

Installation

If you have already downloaded textteaser, run the following command inside this directory:

$ python setup.py install

If you have not yet downloaded textteaser, it would be easier to use pip:

$ pip install textteaser

or easy_install:

$ easy_install textteaser

Either method will install textteaser into your current environment.

Changelog

For a full history of changes see the commit history:

version 0.3

  • Added minimal logging support.

version 0.2

  • Able to summarize text at a given URL.

version 0.1.1

  • Removed caching ability to match API changes.

version 0.1

  • Able to summarize text with the TextTeaser API.
  • Able to retrieve passed summaries quickly through cached ID values.

Development

Development for textteaser takes place on bitbucket:

A mirror is available on GitHub if you prefer:

To get started you can do the following:

$ hg clone https://bitbucket.org/jgoettsch/py-textteaser/
$ cd py-textteaser
$ pip install -r requirements_dev.txt
$ python setup.py develop

If you discover a bug, please create an issue ticket:

To run the test suite, you will have to create a module at:

textteaser/tests/apikey.py

with a global variable, APIKEY, which is a string containing your API key. Then you can run the test suite with nosetests:

$ nosetests --with-coverage --cover-package=textteaser textteaser/tests/tests.py

or through setup.py:

$ python setup.py test