https://github.com/suminb/tldr

Text summarization service
https://github.com/suminb/tldr

Last synced: over 1 year ago
JSON representation

Text summarization service

• Host: GitHub
• URL: https://github.com/suminb/tldr
• Owner: suminb
• License: bsd-3-clause
• Created: 2016-11-16T14:15:26.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2017-04-27T07:55:27.000Z (about 9 years ago)
• Last Synced: 2025-01-18T14:43:29.661Z (over 1 year ago)
• Language: HTML
• Size: 53.7 KB
• Stars: 29
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Travis](https://img.shields.io/travis/suminb/tldr.svg)](https://travis-ci.org/suminb/tldr)

[![Coveralls](https://img.shields.io/coveralls/suminb/tldr.svg)](https://coveralls.io/github/suminb/tldr)

TL;DR

-----

TL;DR, which stands for "Too Long; Didn't Read", is a text summarization service.

Obtaining Docker Image

----------------------

The pre-built Docker image can be obtained by running the following commands:

    docker pull sumin/tldr

Code Build

----------

If you would like to build the code yourself, you will need the following

things:

- Docker

- Python 2.x or 3.x

- Java 6 or higher

The Docker image can be built by running the following command:

    docker build ${directory containing Dockderfile}

Run

---

    docker run -d -p 8804:${host port} sumin/tldr

For example, if you would like to map the 8804 port of the guest host to the

identical port number (8804) of the host, you may want to run the following

command.

    docker run -d -p 8804:8804 sumin/tldr

Invocation

----------

RESTful APIs can be invoked via any standard HTTP client. Use of `curl` or

`wget` is advised.

### Text Summarization

    curl -XPOST -d "text=This is a text" http://localhost:8804/api/v1/summarize

### Text Extraction

    curl -XPOST -d "html=Example" \

        http://localhost:8804/api/v1/extract-text

Tests

-----

    py.test -v tests