Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MoviebaseApp/trakt-kotlin
📺 Modern powerful Trakt API to track, discover and share your movies & TV shows.
https://github.com/MoviebaseApp/trakt-kotlin
android java kotlin kotlin-js kotlin-library kotlin-multiplatform kotlin-native ktor ktor-android ktor-client movies movies-api poster shows tmdb trakt
Last synced: about 2 months ago
JSON representation
📺 Modern powerful Trakt API to track, discover and share your movies & TV shows.
- Host: GitHub
- URL: https://github.com/MoviebaseApp/trakt-kotlin
- Owner: MoviebaseApp
- License: apache-2.0
- Created: 2021-09-25T12:45:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T02:42:34.000Z (10 months ago)
- Last Synced: 2024-04-17T10:37:38.066Z (8 months ago)
- Topics: android, java, kotlin, kotlin-js, kotlin-library, kotlin-multiplatform, kotlin-native, ktor, ktor-android, ktor-client, movies, movies-api, poster, shows, tmdb, trakt
- Language: Kotlin
- Homepage: https://www.moviebase.app
- Size: 433 KB
- Stars: 39
- Watchers: 0
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin-multiplatform - trakt-api
- awesome-list - MoviebaseApp/trakt-kotlin - 📺 Modern powerful Trakt API to track, discover and share your movies & TV shows. (Kotlin)
README
[Website](https://www.trakt.tv) |
[Support](https://support.trakt.tv/support/home) |
[Documentation](https://trakt.docs.apiary.io/)
***Track and discover your TV shows and movies with Trakt.***
[](https://central.sonatype.com/artifact/app.moviebase/trakt-api/)
[](https://github.com/MoviebaseApp/tmdb-api/issues)
[](http://kotlinlang.org)
[](https://gradle.org)
[](http://www.apache.org/licenses/LICENSE-2.0)
[](https://github.com/ChrisKruegerDev)
# Trakt Kotlin
Trakt Kotlin is a **Kotlin Multiplatform** library for tracking your series and movies.
* Written in Kotlin native with ktor from the ground up.
* Support for Android, iOS, desktop, and web applications.
* High customizable HttpClient configuration
Sample projects:
* [tivi](https://github.com/chrisbanes/tivi)
* [Moviebase](https://play.google.com/store/apps/details?id=com.moviebase)
## Setup
The library is available on Maven Central.
### Gradle
Add the Maven Central repository if it is not already there.
```kotlin
repositories {
mavenCentral()
}
```
To use the library in a single-platform project, add a dependency.
```kotlin
dependencies {
implementation("app.moviebase:trakt-api:0.6.0")
}
```
In Kotlin Multiplatform projects, add the dependency to your commonMain source-set dependencies.
```kotlin
commonMain {
dependencies {
implementation("app.moviebase:trakt-api:0.6.0")
}
}
```
## Usage
Most of the library follows the possibilities and naming at the official [Trakt documentation](https://trakt.docs.apiary.io/).
### Configuration
Build up your Trakt instance to access the APIs. You can configure the entire HttpClient of ktor.
```kotlin
val trakt = Trakt {
traktApiKey = "clientId"
expectSuccess = false // if you want to disable exceptions
useCache = true
useTimeout = true
maxRetriesOnException = 3 // retries when network calls throw an exception
// add your own client
httpClient(OkHttp) {
engine {
}
}
httpClient {
// for custom HttpClient configuration
}
}
```
### Get information
For getting basic information about a shows or other media content.
```kotlin
val trakt = Trakt("clientId")
val traktShow = trakt.shows.getSummary(traktSlug = "vikings")
```
### Search
Search for TV shows by a query.
```kotlin
val trakt = Trakt("clientId")
val showPageResult = trakt.search.search(
searchType = TraktSearchType.TMDB,
id = "63639",
mediaType = TraktMediaType.SHOW
)
```
## Contributing 🤝
Please feel free to [open an issue](https://github.com/MoviebaseApp/trakt-kotlin/issues/new/choose) if you have any questions or suggestions. Or participate in the [discussion](https://github.com/MoviebaseApp/trakt-kotlin/discussions). If you want to contribute, please read the [contribution guidelines](https://github.com/MoviebaseApp/trakt-api/blob/main/CONTRIBUTING.md) for more information.
*This library uses the Trakt but is not endorsed or certified by Trakt.*