Code Monkey home page Code Monkey logo

readabilitykit's Introduction

ReadabilityKit

CI Status Version Carthage Compatible License Platform

ReadabilityKit helps you to extract a relevant preview (title, description, image and video) from the URL.

The goal is to try and get the best extraction from the article for servicing applications that need to show a preview of a web URL along with an image. Comparison with other extraction libraries available here. Comparison with another iOS extraction library (SwiftLinkPreview) available here.

Inspired by snacktory and newspaper.

Demo

Features

Extracts:

  • Title
  • Description
  • Top image
  • Top video
  • Keywords

Requirements

  • iOS 8.0+ / Mac OS X 10.9+ / tvOS 9.0+ / watchOS 2.0+

Usage

Readability.parse(url: articleUrl, { data in
  let title = data?.title
  let description = data?.description
  let keywords = data?.keywords
  let imageUrl = data?.topImage
  let videoUrl = data?.topVideo
})

To run the example project, clone the repo, and run pod install from the Example directory first.

Comparison with other libraries

ReadabilityKit SwiftLinkPreview python-goose snacktory newspaper
github
washingtonpost
youtube ☑️ ☑️
vimeo ☑️
instagram ☑️
nytimes
twitter ☑️
medium
facebook ☑️ ☑️ ☑️
imgur
flickr
500px
dribbble ☑️
lenta ☑️
habrahabr ☑️
bbc

✅ – correct ☑️ – partially correct ❌ – incorrect

ReadabilityKit vs SwiftLinkPreview

  • ReadabilityKit uses part of ar90 algorithm which was transformed into the Redability.com product. This allows for more accurate extraction.
  • Video support. ReadabilityKit detects videos on the page and extracts the most relevant to Readability.topVideo.
  • Typed API that allows you to use statically typed properties without force casting.
  • Keyword extraction.

Installation

CocoaPods

ReadabilityKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
    pod 'ReadabilityKit'
end

To integrate ReadabilityKit into your Xcode project using Carthage, specify it in your Cartfile:

github "exyte/ReadabilityKit" ~> 0.5.2

Manually

  1. Install Ji XML parser
  2. Download and drop all files from Sources folder in your project
  3. Congratulations!

Author

exyte, [email protected]

License

ReadabilityKit is available under the MIT license. See the LICENSE file for more info.

readabilitykit's People

Contributors

vhailor13 avatar zapletnev avatar lfarah avatar

Watchers

James Cloos avatar

Forkers

readom

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.