JarCastingPenicillin: Modern powerful Twitter API wrapper for Kotlin Multiplatform
- Supports JVM, Android (API level >= 24), JS (Both browsers and NodeJS).
- Supports all the public Twitter API endpoints.
- Supports the following authenticating methods: OAuth 1.0a, OAuth 2.0
- Supports some private Twitter API endpoints such as Poll Tweets.
- Endpoint's parameters are resolved as Kotlin "Typed-safe Named Parameter".
- Penicillin has model classes. So responses are easy to use.
- API's execution supports classical blocking function
.complete(), suspend function.execute(), deferred operation.executeAsync()and callback style.queue {}. - Cursor APIs such as
friends/listhave methods named.next,.untilLast(). It makes paging easy.
Documentations are available at docs.starry.blue.
Quick Example
suspend fun main() {
// Creates new ApiClient
PenicillinClient {
account {
application("ConsumerKey", "ConsumerSecret")
token("AccessToken", "AccessToken Secret")
}
}.use { client ->
// Retrieves user timeline from @realdonaldtrump up to 100.
client.timeline.userTimeline(screenName = "realdonaldtrump", count = 100).execute().forEach { status ->
// Prints status text.
println(status.text)
}
}
}
More examples of Penicillin can be found at Wiki. Please feel free to create new issue if you have any questions.
Get Started
Latest Penicillin version is
Stable releases are available at Bintray. EAP builds are also available (Dev Repository). Every commit is published as EAP build.
You may choose preferred Ktor HttpClient Engine. We recommend using Apache or CIO engine on JVM.
Full engine list is available at https://ktor.io/clients/http-client/engines.html.
Gradle
build.gradle.kts:
val ktorVersion: String = "1.5.0"
repositories {
mavenCentral()
jcenter()
maven(url = "https://kotlin.bintray.com/kotlinx")
maven(url = "https://dl.bintray.com/starry-blue-sky/stable")
// or dev repository if EAP builds preferred
// maven(url = "https://dl.bintray.com/starry-blue-sky/dev")
}
kotlin {
sourceSets {
named("commonMain") {
dependencies {
implementation("blue.starry:penicillin:$PenicillinVersion")
}
}
// Not needed anymore: Penicillin 6.0.0+
named("jvmMain") {
}
named("jsMain") {
}
}
}
Compatibility
Currently, Penicillin works on JVM (Java 8), Android (API level >= 24) or JS (both browsers and NodeJS).
In the future, Penicillin is plan to support Kotlin/Native. It brings the benefits of reuse for Kotlin code and saves you from wasting time.
For example, if you only write Kotlin code once, it can be compiled for JVM, JavaScript, iOS, Android, Windows, macOS and so on.
In Android development, we confirmed that Penicillin works only on API level 24 or greater. It's caused by Ktor-side restriction. Detail information is here.
Contributing
License
Penicillin is provided under the MIT license.
Copyright (c) 2017-2020 StarryBlueSky.