Skip to content
/ tldr Public
forked from VeeBack/tldr

🀏 TL;DR (Too Long Didn't Read) summarises text on web pages. Used in Dot Browser.

License

Notifications You must be signed in to change notification settings

jp-krow/tldr

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎨 TL;DR

TL;DR (Too long didn't read) is a service to summarize text with a given website.

πŸ“Œ Installation

Install requirements in requirements.txt with pip

pip install -r requirements.txt

Then load up your favorite python IDE and run main.py or use your terminal

python main.py

πŸ“ Usage

Send a POST request to the local flask application in page /sum with the following:

Content-Type: application/x-www-form-urlencoded

site-language=english
url=[your url here]
sentences=5
cached=true

πŸ”– More Information

site-language is the language the selected website uses, changing this to another language may mess up the summarization.

url is your chosen url.

sentences (Optional) tells how much sentences you want to receive back (Defaults to 10 if not provided.)

cached (Optional) enables or disables google's cached save of the url (useful if the website has anti-bot measures in place, or keep receiving an error.)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MPL-2.0

About

🀏 TL;DR (Too Long Didn't Read) summarises text on web pages. Used in Dot Browser.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%