opengraphKt

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 20 Open GitHub ↗

A dead simple OpenGraph tags parser for Kotlin

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OpenGraphKt

[![Build Status](https://github.com/haroldadmin/opengraphKt/workflows/Gradle%20Build/badge.svg)](https://github.com/haroldadmin/opengraphKt/actions)

A dead simple [OpenGraph Tags](https://ogp.me/) parser for Kotlin, built using Coroutines and [Jsoup](https://jsoup.org/).

## Usage

The API is exposed through suspending extension functions.

```kotlin
// In a coroutine scope, or inside runBlocking

val url = URL("https://ogp.me/")
val tags = url.getOpenGraphTags()

println("""
Title: ${tags.title}
Description: ${tags.description}
Locale: ${tags.getProperty("locale")}
""")
```

The `getOpenGraphTags()` method returns a `Tags` class which only acts
as a wrapper around the underlying `Map<String, List<String>>` object.

`Tags` is an **inline class**, and [Inline classes](https://kotlinlang.org/docs/reference/inline-classes.html) are currently experimental, so make sure you're okay with that before using this library.

## Limitations

The library currently only supports the `og:` namespace.

## Contribution

Please feel free to open issues or contribute new features through pull requests.

## Download

The library is published on Jitpack. Make sure to add it as a repository to your `build.gradle` file:

```groovy
allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}
```

And then add the library dependency:
```groovy
dependencies {
  implementation "com.github.haroldadmin:opengraphKt:(latest-version)"
}
```
[![Latest Version](https://jitpack.io/v/haroldadmin/opengraphKt.svg)](https://jitpack.io/#haroldadmin/opengraphKt)

opengraphKt

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README