franfj / summarizer

Text summarization Python library (in progress)

Text-Summarizer

Text summarization Python library (in progress)

Project status

• 
• 
• 
• 

Installation

pip install text-summarizer

Packages needed

See requirements.txt

Usage

# Import summarizer
from text_summarizer import summarizer

# Init summarizer parameters
summarizer.text = input_text
summarizer.algo = Summ.TEXT_RANK    # Summ.TEXT_RANK is equal to "textrank"
summarizer.percentage = 0.25

# Summarize with summarize() (returns a paragraph) or schematize() (returns a schema)
summarizer.summarize()
summarizer.schematize()

# You can also init the parameters in the summarize() / schematize() call
summarizer.summarize(text_to_be_summarized)
summarizer.summarize(text_to_be_summarized, "textrank", 0.5)

More (theorical) information about text summarization

More info in icoxfog417/awesome-text-summarization

License

Copyright 2018 Francisco Javier Rodrigo Ginés

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

summarizer's Issues

Refactor TextRank algorithm

Refactor following files:

• text_rank_algo.py
• tf_idf.py
• cosine_similarity.py

Investigate about Summ enum type pros & cons

Decide whether to keep the Summ enum type or use string literals.

Extend readme file

Extend readme file explaining the library usage and how to install it.

Fix text read

Fix text read in order to read multiple types of files (in line, multi-line, etc.)

Create requirements file

Create requirements file.

ImportError: cannot import name 'summarizer' from 'text_summarizer'

I already install packages in requirements.txt, any idea why I got ImportError: cannot import name 'summarizer' from 'text_summarizer'?

Thanks!

Add code examples

• Add simple example
• Add an example using jupyter notebooks

Improve readme

• Explain the theory behind each summarization method implemented
• Explain how to install needed packages
• Explain better how to use summarizer

Develop TF-IDF

Develop TF-IDF for TextRank/LexRank.

Develop feature based summarization

See awesome-text-summarization: Feature base for more info.

Develop cosine similarity

Develop cosine similarity for TextRank/LexRank.