https://github.com/StarryBlueSky/Penicillin

Modern powerful Twitter API wrapper for Kotlin Multiplatform. #PureKotlin
https://github.com/StarryBlueSky/Penicillin

api-wrapper kotlin kotlin-coroutines kotlin-multiplatform twitter twitter-api twitter-api-wrapper

Last synced: 14 days ago
JSON representation

Modern powerful Twitter API wrapper for Kotlin Multiplatform. #PureKotlin

• Host: GitHub
• URL: https://github.com/StarryBlueSky/Penicillin
• Owner: StarryBlueSky
• License: mit
• Archived: true
• Created: 2017-08-30T05:18:52.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-12T01:19:32.000Z (over 1 year ago)
• Last Synced: 2024-07-31T20:26:43.369Z (3 months ago)
• Topics: api-wrapper, kotlin, kotlin-coroutines, kotlin-multiplatform, twitter, twitter-api, twitter-api-wrapper
• Language: Kotlin
• Homepage: https://starrybluesky.github.io/Penicillin/
• Size: 9.61 MB
• Stars: 88
• Watchers: 7
• Forks: 5
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-kotlin-multiplatform - Penicillin

README

        
# Penicillin: Modern powerful Twitter API wrapper for Kotlin Multiplatform

[![Kotlin](https://img.shields.io/badge/Kotlin-1.7-blue.svg)](https://kotlinlang.org)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/StarryBlueSky/Penicillin)](https://github.com/StarryBlueSky/Penicillin/releases)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/StarryBlueSky/Penicillin/Check)](https://github.com/StarryBlueSky/Penicillin)

[![license](https://img.shields.io/github/license/StarryBlueSky/Penicillin.svg)](https://github.com/StarryBlueSky/Penicillin/blob/master/LICENSE)

[![issues](https://img.shields.io/github/issues/StarryBlueSky/Penicillin.svg)](https://github.com/StarryBlueSky/Penicillin/issues)

[![pull requests](https://img.shields.io/github/issues-pr/StarryBlueSky/Penicillin.svg)](https://github.com/StarryBlueSky/Penicillin/pulls)

* Supports Java 8 or later, Android (API level 24 or higher), JavaScript target. 

* Supports all of Twitter's v1.1 public APIs and some v2 public and private APIs. 

* All endpoint parameters can be represented by named parameters.

* There are model classes for response JSON, which can be accessed type-safely.

* Paging APIs can be handled by [Flow](https://kotlinlang.org/docs/flow.html).

Documentation is available at [GitHub Pages](https://starrybluesky.github.io/Penicillin/).  

## Quick Example

```kotlin

suspend fun main() {

    // Create new PenicillinClient.

    PenicillinClient {

        account {

            application("ConsumerKey", "ConsumerSecret")

            token("AccessToken", "AccessToken Secret")

        }

    }.use { client ->

        // Retrieve up to 100 tweets from @POTUS.

        val timeline = client.timeline.userTimelineByScreenName(screenName = "POTUS", count = 100).execute()

        // The return value of the timeline is `JsonArrayResponse`. It implements `Iterable`, which allows iterative operations.

        timeline.forEach { status ->

            // Print unescaped status text. If you want to get the raw html reference characters, you can use `textRaw`.

            println(status.text)

        }

    }

}

```

Other examples can be found at [Wiki](https://github.com/StarryBlueSky/Penicillin/wiki/Sample). If you have any questions, please let us know at [Issue](https://github.com/StarryBlueSky/Penicillin/issues/new).

## Get Started

Penicillin is now available in the Maven Central since version 6.1.0. The previous Bintray repository is no longer available.

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/StarryBlueSky/Penicillin)](https://github.com/StarryBlueSky/Penicillin/releases)

### Gradle

#### build.gradle.kts:

```kotlin

dependencies {

    implementation("blue.starry:penicillin:$PenicillinVersion")

    

    // Choose your favorite engine from https://ktor.io/clients/http-client/engines.html

    // The version should match the version of Ktor that Penicillin is using.

    implementation("io.ktor:ktor-client-apache:1.6.8")

    implementation("io.ktor:ktor-client-cio:1.6.8")

}

```

## License

Penicillin is provided under the MIT license.  

Copyright (c) 2017-2022 StarryBlueSky.