https://github.com/adichat/senpai
:dash:Making communication📞easier and faster🚅for all 👦 + 👧 + 👴 + 👶 + 🐮 + 🐦 + 🐱
https://github.com/adichat/senpai
block-score cluster-rank conversation module pypi python segmentation text-rank text-summarization texttiling vocabulary-introduction
Last synced: about 2 months ago
JSON representation
:dash:Making communication📞easier and faster🚅for all 👦 + 👧 + 👴 + 👶 + 🐮 + 🐦 + 🐱
- Host: GitHub
- URL: https://github.com/adichat/senpai
- Owner: AdiChat
- License: mit
- Created: 2016-09-08T12:23:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-14T16:14:46.000Z (about 4 years ago)
- Last Synced: 2025-03-19T09:14:18.048Z (2 months ago)
- Topics: block-score, cluster-rank, conversation, module, pypi, python, segmentation, text-rank, text-summarization, texttiling, vocabulary-introduction
- Language: Python
- Homepage: https://pypi.python.org/pypi/readless
- Size: 30.3 KB
- Stars: 48
- Watchers: 6
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReadLess 📖
A python module for conversation📞 and text 📚 summarization and much more exciting features.
Find this module on **PyPI**:dash: [**here**](https://pypi.python.org/pypi/readless)
###💪_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](http://www.python.org/) 2.7+ and [pip](https://crate.io/packages/pip/)([Windows](http://docs.python-guide.org/en/latest/starting/install/win/), [Linux](http://docs.python-guide.org/en/latest/starting/install/linux/)) installed. Simply, run:
```sh
$ [sudo] pip install readless
```
Or for the latest version in development:
```sh
$ [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:
```python
# -*- 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:
```python
# -*- 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**](https://github.com/AdiChat/Read-Less/tree/master/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](https://github.com/AdiChat/Read-Less/wiki/Future-Developments).
### 👮 [LICENSE](https://github.com/AdiChat/Read-Less/blob/master/LICENSE)