exyte / readabilitykit

Preview extractor for news, articles and full-texts in Swift

ReadabilityKit

Preview extractor for news, articles and full-texts in Swift

---

We are a development agency building phenomenal apps.

!Project is now archived!

No further maintenance will be performed

Features

Extracts:

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

Usage

let articleUrl = URL(string: "https://someurl.com/")!
Readability.parse(url: articleUrl, completion: { data in
    let title = data?.title
    let description = data?.description
    let keywords = data?.keywords
    let imageUrl = data?.topImage
    let videoUrl = data?.topVideo
    let datePublished = data?.datePublished
})

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

Installation

CocoaPods

pod 'ReadabilityKit'

Carthage

github "exyte/ReadabilityKit"

Manually

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

Development Environment Setup

1. Install Carthage.
2. Check out and build the project's dependencies:

carthage bootstrap --platform <name>

Requirements

• iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+

License

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

readabilitykit's Issues

iOS 11, Swift 4, Xcode 9

Just a heads up, some parsing in Readability doesn't work for iOS 11 and Swift 4. If you'd like, I can take a look into these issues and commit some changes to another branch?

Project structure refactoring.

Move ReadabilityKit workspace to root.
Add Example as separate project.
Move tests to ReadabilityKit workspace from Example project.

Provide full text of the article

Property Readabilty.text
Please check #12

Twitter and Youtube not been parsed

Hi,

In the initial testing of this Kit, I found out that it is unable to find parse the any data from the following,

• Twitter

• Youtube

Any ideas, as to what would be causing this issue, would be helpful.
Thanks.

Importing as Swift Package direct from `master` branch breaks with .watchOS v3 platform version

When trying to import the project directo from Swift Package Manager, SPM halts in a a non conformance error for watchOS platform version.

This issue can be simulated opening the Swift Package from master branch, also.

The issue is related to this line where the platform enumerator "." dot was mistyped. Typo error.

ReadabilityKit/Package.swift

Line 10 in 9e7e631

.watchOS(v3),

Get html content like Reader Mode in Safari

Hi there,
Is it possible to get not just a plain text, but html of extracted article including images and videos?

Carthage: error: module compiled with Swift 4.0 cannot be imported in Swift 4.0.2

Running carthage update fails on the most recent version of Xcode.

error: module compiled with Swift 4.0 cannot be imported in Swift 4.0.2: /Users/sam/Documents/dev/DispatchApp/Carthage/Checkouts/ReadabilityKit/Dependencies/iOS/Ji.framework/Modules/Ji.swiftmodule/arm64.swiftmodule

Build version 9B55

I'm happy to submit a PR to fix, but I'm unsure how to get the libraries from the Ji project.

Campare with ar90 implementation.

https://github.com/masukomi/ar90-readability

Some URLS are not parsed.

Some URLS are not parsed? It's either that or the URLSession request takes quite long to parse the data. Is there a way to improve its speed/performance?

iOS 10 App Transport Security

In iOS 10, Apple has promised to turn off ATS for developers who want to submit to the App Store. In this scenario, what are the plans to support this?

Adding date extraction feature

Any ideas to how to parse date from the article?

Wrong instructions for manual installation

Commit: 84cadfc
Author: @lfarah

It isn't enough to copy ReadabilityKit.swift into your project since we have third-party dependency to XML parser Ji.

Employ asynchronous patterns

I would suggest that this code excise its use of dispatch semaphores to make the fundamentally asynchronous NSURLSession behave synchronously. Apple made this asynchronous for a reason.

If a user accidentally called this from the main thread, you'd block the main thread, which results in behaviors ranging from a poor UX to an app possibly getting killed by the watchdog process. Worse, if a user called this from within their own NSURLSession completion handler (e.g. http://stackoverflow.com/q/39253599/1271826), this will deadlock their code.

I'd also suggest that you not initiate the asynchronous method from within the init method. By convention, one should generally configure the object from within init, and then have a separate method to start the process.

Issue with Linkedin url

library not working with url "https://www.linkedin.com". Image not coming.

cannot parse certain websites

" https://economictimes.indiatimes.com/tech/hardware/the-iphone-se-is-in-india-heres-all-we-know/not-a-flagship/slideshow/76280131.cms "

I have implemented this pod in my project. But it seems to not parse the url's that end with ".cms".

Image support

The library does not recognize image url.
example: http://i.stack.imgur.com/ILTQq.png

a nil value is returned by "topImage" attribute

Swift 3 Help

Ji.swift and JiNode.swift are both broken in swift 3. Can't figure out how to fix them with things like "openlass", "fileprifilevate", opeoppened" etc.

Manual Installation

CocoaPods is an awesome tool and make our life really easier, but there are some devs who still don't know how to use them.

It would be cool to add the Manual installation guide in your README.md. You can take a look at my iOS Readme Template to see how you can do it.

Is Swift 5 support planned ?

GIF

I'd be cool to show a GIF or an Image showing the power of ReadabilityKit

Swift 3 support

Is this in the works? What can I do to help?

Could not build Objective-C module 'ReadabilityKit'

Create competitors page

Need to compare with other tools such as:

• python-goose
• snacktory
• python-readability
• newspaper
• jsreadability

Issues using library in Objective-C code

podfile
use_frameworks!
pod 'ReadabilityKit'

Unable to call [Readability parse] ...

fix typo - change from "posetive" to "positive"

Cool project.

There is a typo. The word is posetive and posetiveRegExp in the file Readability.swift

iOS Swift: Using table view cell, image switch issue

first time image loads, user scrolls down and get back to a certain cell he/she saw previously.
it get latest images first an the it updates to actual depending upon the content in URL

Incorrect description of articles

Try to load articles
"http://www.jobsnhire.com/articles/35030/20160214/need-know-cvs-health.htm"
"http://www.bbc.com/news/world-asia-china-37081013"
"http://www.bbc.com/culture/story/20160805-when-shocking-images-must-be-covered-up"
"http://football.ua/germany/311510-podolski-zavershil-kareru-v-sbornojj.html"

using code
let sURL = "http://football.ua/germany/311510-podolski-zavershil-kareru-v-sbornojj.html"
let articleUrl = NSURL(string: sURL)

    let parser = Readability(url: articleUrl!)

    let title = parser.title()
    let description = parser.description()
    let keywords = parser.keywords()
    let imageUrl = parser.topImage()
    let videoUrl = parser.topVideo()

For all this articles parser.description() returns only their first paragraph.

nm

Error when trying to add with SPM

Trying to add with SPM, getting the following error: [email protected]:exyte/ReadabilityKit.git has no Package.swift manifest for version 0.7.4

Can't build framework (Carthage + Xcode 8.2.1)

When trying to build ReadabilityKit 0.6.0 using carthage update --platform iOS, it gets to Building scheme "ReadabilityKit iOS" in ReadabilityKit.xcodeproj before saying ** BUILD FAILED **. The full output:

** BUILD FAILED **


The following build commands failed:
	CompileSwift normal arm64
	CompileSwiftSources normal arm64 com.apple.xcode.tools.swift.compiler
(2 failures)
A shell task (/usr/bin/xcrun xcodebuild -project /Users/orion/Dropbox/Code/Feeds/Carthage/Checkouts/ReadabilityKit/ReadabilityKit.xcodeproj -scheme "ReadabilityKit iOS" -configuration Release -sdk iphoneos ONLY_ACTIVE_ARCH=NO BITCODE_GENERATION_MODE=bitcode CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= CARTHAGE=YES clean build) failed with exit code 65:
** BUILD FAILED **


The following build commands failed:
	CompileSwift normal arm64
	CompileSwiftSources normal arm64 com.apple.xcode.tools.swift.compiler
(2 failures)

When changing the target in my Cartfile to 0.5.4, it builds fine.

How can i use 7.01 version in Objective C

Carthage support

Publish ReadabilityKit into Carthage

Video extraction

Reference:
https://github.com/grangier/python-goose#video-extraction

Initializer for conditional binding

Building example and get error:

Initializer for conditional binding must have Optional type, not 'String'

From Readability+Networking.swift:

guard let urlStr = url.absoluteString else {
return
}

Can change to the following to fix:

let urlStr = url.absoluteString

Thanks.