kpastebin

Multiplatform Kotlin library to interact with the pastebin.com API.

Programming language: Kotlin

License: Mozilla Public License 2.0

Tags: Misc    

README

KPastebin

Multiplatform Kotlin library to interact with the pastebin.com API.

Setup

1. Add the lib to your project's dependencies:

• Groovy (replace $kpastebin_version with the version you want):

  // universal dependency for Gradle 5.3 and above
  // in case of multiplatform project, just specify the dependency for commonMain/commonTest source set
  implementation "net.pearx.kpastebin:kpastebin:$kpastebin_version" 
  

  // for Gradle versions below 5.3:
  implementation "net.pearx.kpastebin:kpastebin-metadata:$kpastebin_version" // for Common
  // or
  implementation "net.pearx.kpastebin:kpastebin-jvm:$kpastebin_version" // for JVM
  // or
  implementation "net.pearx.kpastebin:kpastebin-js:$kpastebin_version" // for JS
  // or
  implementation "net.pearx.kpastebin:kpastebin-android:$kpastebin_version" // for Android
  // or
  implementation "net.pearx.kpastebin:kpastebin-PLATFORM_YOU_WANT:$kpastebin_version" // for Native
  

• Kotlin (replace $kpastebinVersion with the version you want):

  // universal dependency for Gradle 5.3 and above
  // in case of multiplatform project, just specify the dependency for commonMain/commonTest source set
  implementation("net.pearx.kpastebin:kpastebin:$kpastebinVersion") 
  

  // for Gradle versions below 5.3:
  implementation("net.pearx.kpastebin:kpastebin-metadata:$kpastebinVersion") // for Common
  // or
  implementation("net.pearx.kpastebin:kpastebin-jvm:$kpastebinVersion") // for JVM
  // or
  implementation("net.pearx.kpastebin:kpastebin-js:$kpastebinVersion") // for JS
  // or
  implementation("net.pearx.kpastebin:kpastebin-android:$kpastebinVersion") // for Android
  // or
  implementation("net.pearx.kpastebin:kpastebin-PLATFORM_YOU_WANT:$kpastebinVersion") // for Native
  

1. Add kotlinx.coroutines and any Ktor client engine to your project's dependencies.

2. Use the library and have fun! See [net.pearx.kpastebin.PastebinClient](src/commonMain/kotlin/net/pearx/kpastebin/PastebinClient.kt) class KDoc for more info.

Examples

runBlocking {
    // see KDoc for more info
    val client = PastebinClient("your dev key") // create a PastebinClient instance. You can get your dev key here: https://pastebin.com/doc_api#1
    client.getPaste("0b42rwhf") // getting a paste

    client.login("username", "password") // logging in
    client.getUserDetails().accountType // getting current user account type
}