https://github.com/dezoito/flask_summarizer
A Dockerized Flask based API to summarize documents and articles (Visual Interface and tests included).
https://github.com/dezoito/flask_summarizer
article docker flask nltk phantomjs python selenium textrank
Last synced: 4 months ago
JSON representation
A Dockerized Flask based API to summarize documents and articles (Visual Interface and tests included).
- Host: GitHub
- URL: https://github.com/dezoito/flask_summarizer
- Owner: dezoito
- Created: 2014-11-06T16:56:58.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-01-28T21:20:55.000Z (over 6 years ago)
- Last Synced: 2025-02-14T13:50:35.384Z (8 months ago)
- Topics: article, docker, flask, nltk, phantomjs, python, selenium, textrank
- Language: Python
- Homepage:
- Size: 367 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
flask_Summarizer
---------------------------------------------------
A very simple Flask based API to create a summary from documents and articles.
### Updates
[Jan-2019] Improvements to the API, including auto-generated swagger documentation,
courtesy of [Flask RestPlus](https://github.com/noirbizarre/flask-restplus):
Navigating to the root URL let's you see the automatically generated documentation for all endpoints and test them on the fly.
You can also go to `/form` to test the API using an HTML client form.
### Dockerizing this app
You can use Docker to run the application in development or in production mode (assuming you have Docker and Docker Compose installed).
#### Development Mode
To build the app run in development mode just cd to the project root and run:
```sh
./rundev.sh
```
If everything runs smoothly, you will be able to open the app from [http://localhost:5000](http://localhost:5000).
This will run the app using Flask's built-in server on port 5000 and install testing dependencies (such as PhantomJS).
#### Production Mode
To build the app run it in production, cd to the project root and run:
```sh
./runprod.sh
```
This will install gunicorn, nginx and serv it on port 80
Note: If you want to run it on a virtualenv, you'll have to manually setup NLTK and
install PhantomJS (see [`sh_scripts/install.sh`](https://github.com/dezoito/flask_Summarizer/blob/master/sh_scripts/install_phantom_js.sh) to see how it's done in Ubuntu).
### Running Tests
The functional tests still use PhantomJS's headless browser (I left them because some people might still find this useful).
From the `tests/` directory, run:
```sh
python3 -m unittest discover
```
You can also run individual test suites:
```sh
python3 -m unittest tests_unit
python3 -m unittest tests_views
python3 -m unittest tests_api
python3 -m unittest tests_phantomJS
```
### References:
Flask Summarizer is based on the following projects:
**Summarize.py:**
https://github.com/Rotten194/summarize.py
**Python implementation of TextRank:**
http://www.davidadamojr.com/textrank-implementation-in-python-github-repo/
The Textrank algorithm seems to deliver a better summary, but was taking too
long to run, so I just use a customized version of summary.py (I'm using Brazilian Portuguese Stopwords and Tokenizer).