senpai icon indicating copy to clipboard operation
senpai copied to clipboard

:dash:Making communication📞easier and faster🚅for all 👦 + 👧 + 👴 + 👶 + 🐮 + 🐦 + 🐱

ReadLess 📖

A python module for conversation📞 and text 📚 summarization and much more exciting features.

Find this module on PyPI:dash: here

###💪_Features_ provided by this module:

  • Text Segmentation using:
    • TextTiling with Block Score
    • TextTiling with Vocabulary introduction
  • Conversational summarization using:
    • Cluster Rank
  • Text summarization using :
    • TextRank
    • Random

Installation 🏭

Make sure you have Python 2.7+ and pip(Windows, Linux) installed. Simply, run:

$ [sudo] pip install readless

Or for the latest version in development:

$ [sudo] pip install git+git://github.com/adichat/read-less.git

ReadLess API 📚 🗽

You can use readless like a library in your project.

For quickly summarizing a conversation using ClusterRank algorithm:

# -*- coding: utf8 -*-

from readless.Summarization import clusterrank
summarizer = clusterrank.ClusterRank()
pathToFile = "C:/conversation.in"
summary = summarizer.summarizeFile(pathToFile)

For segmenting a text using TextTiling algorithm:

# -*- coding: utf8 -*-

from readless.Segmentation import texttiling
segmentation = texttiling.TextTiling()
pathToFile = "C:/conversation.in"
segmentedText = segmentation.segmentFile(pathToFile)

For a detailed list of other API functionalities, see ReadLess Documentation.

Contributions 📂

All contributions are welcomed. This module is in development and there are several scopes of improvement. Tests are to be implemented along with other Summarization algorithms with support for web page summarization. For upcoming features, see Future developments.

👮 LICENSE