Readability

Readability is a tool for extracting and curating the primary readable content of a webpage.
Check out The Documentation for full and detailed guides

Installation

If available in Hex, the package can be installed as:

1. Add readability to your list of dependencies in mix.exs:

```elixir
def deps do
  [{:readability, "~> 0.4"}]
end
```

2. Ensure readability is started before your application:

```elixir
def application do
  [applications: [:readability]]
end
```

Usage

Examples

### Get example page.
%{status_code: 200, body: html} = HTTPoison.get!("https://medium.com/@kenmazaika/why-im-betting-on-elixir-7c8f847b58")

### Extract the title.
Readability.title(html)
#=> "Why I’m betting on Elixir"

### Extract authors.
Readability.authors(html)
#=> ["Ken Mazaika"]


### Extract the primary content with transformed html.
html
|> Readability.article
|> Readability.readable_html
#=>
# <div><div><p id=\"3476\"><strong><em>Background: </em></strong><em>I’ve spent...
# ...
# ...button!</em></h3></div></div>


### Extract only text from the primary content.
html
|> Readability.article
|> Readability.readable_text

#=>
# Background: I’ve spent the past 6 years building web applications in Ruby and.....
# ...
# ... value in this article, it would mean a lot to me if you hit the recommend button!

Options

You may provide options(Keyword type) to Readability.article, including:

• retry_length \\ 250
• min_text_length \\ 25
• remove_unlikely_candidates \\ true,
• weight_classes \\ true,
• clean_conditionally \\ true,
• remove_empty_nodes \\ true,

Test

To run the test suite:

$ mix test

Todo

Check out the main features milestone

Related and Inpired Projects

• readability.js is a standalone version of the readability library used for Firefox Reader View.
• newspaper is an advanced news extraction, article extraction, and content curation library for Python.
• ruby-readability is a tool for extracting the primary readable content of a webpage.

LICENSE

This code is under the Apache License 2.0. See http://www.apache.org/licenses/LICENSE-2.0.