jellyfin/jellyfin-sdk-kotlin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-sdk-kotlin.git synced 2024-11-27 16:10:30 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
Kotlin SDK for Jellyfin, supporting Android and JVM targets
1,752 Commits 20 Branches 74 Tags 108 MiB
Kotlin 100%
0fa8c28dd5
Go to file
Niels van Velzen 0fa8c28dd5 Update javadocJar tasks to not use deprecated buildDir
2024-02-04 14:57:51 +01:00
.github/workflows Drop Java 11 from testing and add Java 21 2024-02-04 14:57:51 +01:00
buildSrc Move dependency repository definition to build.gradle.kts (#385) 2022-04-28 22:00:36 +02:00
docs Use code-group in getting-started and v1.4 migration pages 2022-12-16 22:58:13 +01:00
gradle Update dependency com.android.tools.build:gradle to v8 2024-02-04 14:57:51 +01:00
jellyfin-api Update javadocJar tasks to not use deprecated buildDir 2024-02-04 14:57:51 +01:00
jellyfin-api-ktor Update javadocJar tasks to not use deprecated buildDir 2024-02-04 14:57:51 +01:00
jellyfin-core Update javadocJar tasks to not use deprecated buildDir 2024-02-04 14:57:51 +01:00
jellyfin-model Update javadocJar tasks to not use deprecated buildDir 2024-02-04 14:57:51 +01:00
openapi-generator Remove source and target compatibility options 2024-02-04 14:57:51 +01:00
samples Remove source and target compatibility options 2024-02-04 14:57:51 +01:00
testutils Specify jvmToolchain 2024-02-04 14:57:51 +01:00
.editorconfig Use Vitepress to build markdown documentation 2022-08-28 14:01:52 +02:00
.gitattributes Add .api files 2021-04-03 10:59:54 +02:00
.gitignore Add Vitepress cache to gitignore 2022-12-16 22:58:13 +01:00
.markdownlint.yaml Add markdown linting to CI 2022-09-06 23:06:15 +02:00
android-lint.xml Miscellaneous build script changes (#289) 2021-07-08 23:03:33 +02:00
build.gradle.kts Update deprecated Detekt usages 2024-02-04 14:57:51 +01:00
CODEOWNERS Add CODEOWNERS file 2021-03-18 22:08:46 +01:00
detekt.yaml Disable wildcard imports (#344) 2021-12-23 13:41:22 +01:00
gradle.properties Migrate to new Kotlin Multiplatform source set layout 2022-12-28 20:11:44 +01:00
gradlew Update dependency gradle to v8 2024-02-04 14:57:51 +01:00
gradlew.bat Update dependency gradle to v8 2024-02-04 14:57:51 +01:00
LICENSE Update license to LGPL 3.0 2020-09-13 17:08:50 +02:00
openapi.json Update generated sources to 10.8.13 2023-12-02 12:00:24 +01:00
package-lock.json Update dependency vitepress to v1.0.0-rc.40 2024-02-04 11:58:10 +01:00
package.json Update dependency vitepress to v1.0.0-rc.40 2024-02-04 11:58:10 +01:00
README.md Fix all markdown linter issues 2022-09-06 23:06:15 +02:00
renovate.json Enable Renovate dependency dashboard 2023-11-04 17:12:01 +01:00
settings.gradle.kts Split KtorClient to separate module 2023-05-09 13:04:02 +02:00

README.md

Jellyfin Kotlin SDK

Part of the Jellyfin Project

Logo Banner

LGPL 3.0 license Current Release Maven Central Release
Donate Chat on Matrix Join our Subreddit Release RSS Feed Master Commits RSS Feed

The Kotlin SDK for Jellyfin implements the Jellyfin API to easily access servers. It is currently available for the JVM and Android. Developer documentation is available at kotlin-sdk.jellyfin.org.

Contributing

We welcome contributions to the SDK. Open an issue or ask in our official chats if you plan to make bigger changes.

To validate binary compatibility we use the Binary compatibility validator tool from the Kotlin team. When creating pull requests the api files need to be updated. Use the apiDump Gradle task to generate the api files. Add the changes from this command to a separate commit to make the review process easier.

Testing

The SDK includes two example projects, the kotlin-cli and java-cli, to test various larger functions like server discovery. Besides that we use unit tests to test smaller components, these can be executed with the allTests Gradle task. We recommend adding new tests for changes to the code.

Testing in app

It is also possible to test a new version of the SDK in your own app. Use the publishToMavenLocal Gradle task to publish the SDK to your local system, afterwards you can add mavenLocal() as repository and use the latest-SNAPSHOT version for the SDK. This process is simplified in our official apps by adding an option to the gradle.properties file.