Coder Social home page Coder Social logo

tldr's Introduction

๐ŸŽจ 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

tldr's People

Contributors

jp-krow avatar kierandrewett avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.