Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/drewcarlson/torrentsearch-kotlin

Kotlin multiplatform torrent provider search client
https://github.com/drewcarlson/torrentsearch-kotlin

android jvm kotlin kotlin-multiplatform torrent-search-engine

Last synced: 14 days ago
JSON representation

Kotlin multiplatform torrent provider search client

Host: GitHub
URL: https://github.com/drewcarlson/torrentsearch-kotlin
Owner: DrewCarlson
License: mit
Created: 2020-12-27T20:32:04.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-12-20T00:37:19.000Z (20 days ago)
Last Synced: 2024-12-20T01:27:48.514Z (20 days ago)
Topics: android, jvm, kotlin, kotlin-multiplatform, torrent-search-engine
Language: Kotlin
Homepage: https://drewcarlson.github.io/TorrentSearch-Kotlin/
Size: 740 KB
Stars: 17
Watchers: 4
Forks: 0
Open Issues: 13
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # TorrentSearch Kotlin

![Maven Central](https://img.shields.io/maven-central/v/org.drewcarlson/torrentsearch-jvm?label=maven&color=blue)

![](https://github.com/DrewCarlson/TorrentSearch-Kotlin/workflows/Jvm/badge.svg)

![](https://github.com/DrewCarlson/TorrentSearch-Kotlin/workflows/Js/badge.svg)

![](https://github.com/DrewCarlson/TorrentSearch-Kotlin/workflows/Native/badge.svg)

Multiplatform Torrent Provider API client written in Kotlin.

## About

TorrentSearch-Kotlin enables you to query multiple torrent provides in one request and handle all the results. Supported

providers can be found in [`src/commonMain/kotlin/providers`](src/commonMain/kotlin/providers).

## Usage

```kotlin

val torrentSearch = TorrentSearch()

// Only the content string or imdbId/tmdbId/tvdbId is required

val result = torrentSearch.search {

    content = "big buck bunny"

    category = Category.ALL // Optional: Filter by category

    imdbId = "tt..." // Optional: Find by IMDB id instead of content

    tmdbId = 534 // Optional: Find by TMDB id instead of content

    tvdbId = 874 // Optional: Find by TVDB id instead of content

    limit = 20 // Optional: Limit results per provider endpoint

}

println(result.torrents().toList())

// [TorrentDescription(provider=Libre, title=Big Buck Bunny, magnetUrl=magnet:?xt=urn:btih:...]

```

Some providers may require additional requests to resolve download information for a `TorrentDescription`.

This can be checked on the individual `TorrentDescription`s or for the whole collection returned by a provider.

```kotlin

val searchResult = torrentSearch.search { /* ... */ }

val unresolved = searchResult.providerResults().filter { it.requiresResolution }.toList()

val resultSet = torrentSearch.resolve(unresolved.flatMap { it.torrents })

val torrent = resultSet.torrents.first()

// Now you can access `torrent.magnetUrl` and `torrent.infoHash`

```

## Caching

An optional [`TorrentProviderCache`](src/commonMain/kotlin/TorrentProviderCache.kt)

can be provided to `TorrentSearch` enabled caching for authentication tokens and search results.

The default cache will store auth tokens in memory and does not cache torrent results. To add custom caching behavior,

implement a [`TorrentProviderCache`](src/commonMain/kotlin/TorrentProviderCache.kt) and use it when

constructing `TorrentSearch`.

## Web Demo

The [`web`](web) demo helps with debugging the api and provider implementations, it can be run with

`./gradlew jsBrowserProductionRun` and open [http://localhost:8080](http://localhost:8080) in your browser.

## Download

![Maven Central](https://img.shields.io/maven-central/v/org.drewcarlson/torrentsearch-jvm?label=maven&color=blue)

![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/org.drewcarlson/torrentsearch-jvm?server=https%3A%2F%2Fs01.oss.sonatype.org)

![](https://img.shields.io/static/v1?label=&message=Platforms&color=grey)

![](https://img.shields.io/static/v1?label=&message=Js&color=blue)

![](https://img.shields.io/static/v1?label=&message=Jvm&color=blue)

![](https://img.shields.io/static/v1?label=&message=Linux&color=blue)

![](https://img.shields.io/static/v1?label=&message=macOS&color=blue)

![](https://img.shields.io/static/v1?label=&message=Windows&color=blue)

![](https://img.shields.io/static/v1?label=&message=iOS&color=blue)

```kotlin

repositories {

    mavenCentral()

    // Or snapshots

    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")

}

dependencies {

    implementation("org.drewcarlson:torrentsearch:$torrentsearch_version")

    // For Jvm only:

    implementation("org.drewcarlson:torrentsearch-jvm:$torrentsearch_version")

}

```

Note: it is required to specify a Ktor client engine implementation.

([Documentation](https://ktor.io/clients/http-client/multiplatform.html))

```kotlin

dependencies {

    // Jvm/Android

    implementation("io.ktor:ktor-client-okhttp:$ktor_version")

    implementation("io.ktor:ktor-client-android:$ktor_version")

    // iOS

    implementation("io.ktor:ktor-client-darwin:$ktor_version")

    // macOS/Windows/Linux

    implementation("io.ktor:ktor-client-curl:$ktor_version")

    // Javascript/NodeJS

    implementation("io.ktor:ktor-client-js:$ktor_version")

}

``` 

## License

MIT, see [LICENSE](LICENSE)