Ksoup: Kotlin Multiplatform HTML & XML Parser

Ksoup is a Kotlin Multiplatform library for working with real-world HTML and XML. It's a port of the renowned Java library, jsoup, and offers an easy-to-use API for URL fetching, data parsing, extraction, and manipulation using DOM and CSS selectors.

Ksoup implements the WHATWG HTML5 specification, parsing HTML to the same DOM as modern browsers do, but with support for Android, JVM, and native platforms.

Features

Scrape and parse HTML from a URL, file, or string
Find and extract data using DOM traversal or CSS selectors
Manipulate HTML elements, attributes, and text
Clean user-submitted content against a safe-list to prevent XSS attacks
Output tidy HTML

Ksoup is adept at handling all varieties of HTML found in the wild.

Getting started

Ksoup is published on Maven Central

Include the dependency in commonMain. Latest version

Ksoup published in four variants. Pick the one that suits your needs and start building!

This variant is built without any external IO or Network dependencies. Use this if you want to parse HTML from a string.
```
implementation("com.fleeksoft.ksoup:ksoup-lite:<version>")
```

This variant built with kotlinx-io and Ktor 3

implementation("com.fleeksoft.ksoup:ksoup:<version>")

// Optional: Include only if you need to use network request functions such as
// Ksoup.parseGetRequest, Ksoup.parseSubmitRequest, and Ksoup.parsePostRequest
implementation("com.fleeksoft.ksoup:ksoup-network:<version>")

This variant is built with korlibs-io

implementation("com.fleeksoft.ksoup:ksoup-korlibs:<version>")

// Optional: Include only if you need to use network request functions such as
// Ksoup.parseGetRequest, Ksoup.parseSubmitRequest, and Ksoup.parsePostRequest
implementation("com.fleeksoft.ksoup:ksoup-network-korlibs:<version>")

This variant built with kotlinx-io and Ktor 2

implementation("com.fleeksoft.ksoup:ksoup-ktor2:<version>")

// Optional: Include only if you need to use network request functions such as
// Ksoup.parseGetRequest, Ksoup.parseSubmitRequest, and Ksoup.parsePostRequest
implementation("com.fleeksoft.ksoup:ksoup-network-ktor2:<version>")

This variant built with okio and Ktor 2

implementation("com.fleeksoft.ksoup:ksoup-okio:<version>")

// Optional: Include only if you need to use network request functions such as
// Ksoup.parseGetRequest, Ksoup.parseSubmitRequest, and Ksoup.parsePostRequest
implementation("com.fleeksoft.ksoup:ksoup-network-ktor2:<version>")

NOTE: Variants built with kotlinx do not support gzip files.

Parsing HTML from a String with Ksoup

For API documentation you can check Jsoup. Most of the APIs work without any changes.

val html = "<html><head><title>One</title></head><body>Two</body></html>"
val doc: Document = Ksoup.parse(html = html)

println("title => ${doc.title()}") // One
println("bodyText => ${doc.body().text()}") // Two

This snippet demonstrates how to use Ksoup.parse for parsing an HTML string and extracting the title and body text.

Fetching and Parsing HTML from a URL using Ksoup

//Please note that the com.fleeksoft.ksoup:ksoup-network library is required for Ksoup.parseGetRequest.
val doc: Document = Ksoup.parseGetRequest(url = "https://en.wikipedia.org/") // suspend function
// or
val doc: Document = Ksoup.parseGetRequestBlocking(url = "https://en.wikipedia.org/")

println("title: ${doc.title()}")
val headlines: Elements = doc.select("#mp-itn b a")

headlines.forEach { headline: Element ->
    val headlineTitle = headline.attr("title")
    val headlineLink = headline.absUrl("href")

    println("$headlineTitle => $headlineLink")
}

Parsing Metadata from Website

//Please note that the com.fleeksoft.ksoup:ksoup-network library is required for Ksoup.parseGetRequest.
val doc: Document = Ksoup.parseGetRequest(url = "https://en.wikipedia.org/") // suspend function
val metadata: Metadata = Ksoup.parseMetaData(element = doc) // suspend function
// or
val metadata: Metadata = Ksoup.parseMetaData(html = HTML)

println("title: ${metadata.title}")
println("description: ${metadata.description}")
println("ogTitle: ${metadata.ogTitle}")
println("ogDescription: ${metadata.ogDescription}")
println("twitterTitle: ${metadata.twitterTitle}")
println("twitterDescription: ${metadata.twitterDescription}")
// Check com.fleeksoft.ksoup.model.MetaData for more fields

In this example, Ksoup.parseGetRequest fetches and parses HTML content from Wikipedia, extracting and printing news headlines and their corresponding links.

Ksoup Public functions

Ksoup.parse
Ksoup.parseFile
Ksoup.clean
Ksoup.isValid

Ksoup Network Public functions

Suspend functions
- Ksoup.parseGetRequest
- Ksoup.parseSubmitRequest
- Ksoup.parsePostRequest
Blocking functions
- Ksoup.parseGetRequestBlocking
- Ksoup.parseSubmitRequestBlocking
- Ksoup.parsePostRequestBlocking

For further documentation, please check here: Jsoup

Ksoup vs. Jsoup Performance: Parsing & Selecting 448KB HTML File test.tx

Ksoup vs Jsoup

Open source

Ksoup is an open source project, a Kotlin Multiplatform port of jsoup, distributed under the Apache License, Version 2.0. The source code of Ksoup is available on GitHub.

Development and Support

For questions about usage and general inquiries, please refer to GitHub Discussions.

If you wish to contribute, please read the Contributing Guidelines.

To report any issues, visit our GitHub issues, Please ensure to check for duplicates before submitting a new issue.

Library Status

Platform	Status	Notes
Android	Stable
JVM	Stable
iOS	Stable
JS	Alpha
WasmJs	Alpha	not supported with ktor2
Native MacOS	Alpha
Linux	Experimental
Native Windows	Experimental

License

Copyright 2023 Sabeeh Ul Hussnain

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

fleeksoft / ksoup

readme