Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dinhanhx/text-summarizer
A repos for USTH SE 2020 Group 1 project. It's quite obvious in the title.
https://github.com/dinhanhx/text-summarizer
docx english odt pdf python3 summarization text text-summarizer wikipedia-article
Last synced: 2 months ago
JSON representation
A repos for USTH SE 2020 Group 1 project. It's quite obvious in the title.
- Host: GitHub
- URL: https://github.com/dinhanhx/text-summarizer
- Owner: dinhanhx
- License: unlicense
- Created: 2020-03-04T07:02:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-22T22:06:56.000Z (over 2 years ago)
- Last Synced: 2023-08-01T08:27:19.552Z (over 1 year ago)
- Topics: docx, english, odt, pdf, python3, summarization, text, text-summarizer, wikipedia-article
- Language: Python
- Homepage:
- Size: 979 KB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Text summarizer
A repos for USTH SE 2020 Group 1 project. It's quite obvious in the title.
[](https://www.python.org/downloads/)
[](https://unlicense.org/)
## Warning
If you want to contribute to this repos, please read [CONTRIBUTING.md](https://github.com/dinhanhx/text-summarizer/blob/master/CONTRIBUTING.md)
If you git clone or download the repos, you will have nightly-build product.
If you download ['Release' section](https://github.com/dinhanhx/text-summarizer/releases), you will have stable product.
You can check out ['Wiki' section](https://github.com/dinhanhx/text-summarizer/wiki) to understand more about the backend and the frontend.
## 1. Requirements
```
pip install -r requirements.txt .
```
Run this command line in 'modules' folder to set up all packages.
```
python nltk_downloads.py
```
Run this command line in 'modules' folder to set up all components related to [nltk](https://www.nltk.org/).
## 2. Ignite the app
```
python text-sum-core.py
```
Run this command line in 'webapp' folder to start the application.
Open your favorite browser and go to this [link.](http://localhost:5000/text-summarizer)
```
http://localhost:5000/text-summarizer
```
## 3. Usage
It's quite easy to use.
### Plain text (in English)
You can paste your long text in the first input box then click summarize this.
The web app will return you as text file named out.txt
### Wikipedia article (in English)
You can paste a link to an English Wikipedia article such as [this](https://en.wikipedia.org/wiki/Loss_function) or [that](https://en.wikipedia.org/wiki/Communist_Party_of_Georgia_(Soviet_Union))
```
https://en.wikipedia.org/wiki/Communist_Party_of_Georgia_(Soviet_Union)
https://en.wikipedia.org/wiki/Loss_function
```
The web app will return you as text file named out.txt
### Documents (Purely created and in English)
You can upload a .pdf, .odt, .docx file then click summarize this.
The web app will return you as text file named out.txt
## 4. Some documents
You can check out in 'documents' folder.
[Software Requirements](https://docs.google.com/document/d/1JPUjkj7WB9qNS9bpn55QV00t1JlRpcWaTEJ1eBziqg0/)
[Software Design](https://docs.google.com/document/d/108BHsuCUpyInWNZPYqluplRkP0l9gAbkfa2SGPCXjkk/)
## 5. Videos
[March Update](https://youtu.be/UZ9a2ci0-4Q)
[April Update](https://youtu.be/4AlDmCvgi20)
[Mid April Update](https://youtu.be/qH50rilTa6E)
[Final Update](https://youtu.be/f7YnJZKgQMU)
~ Author: Vu Dinh Anh ~