https://github.com/ChromasIV/KTweet

KTweet is a Kotlin Library that allows you to consume the Twitter API v2.
https://github.com/ChromasIV/KTweet

Last synced: 3 months ago
JSON representation

KTweet is a Kotlin Library that allows you to consume the Twitter API v2.

• Host: GitHub
• URL: https://github.com/ChromasIV/KTweet
• Owner: ChromasIV
• License: apache-2.0
• Created: 2021-10-11T15:37:46.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T03:46:37.000Z (about 1 year ago)
• Last Synced: 2024-05-12T06:34:00.163Z (6 months ago)
• Language: Kotlin
• Homepage: https://chromasgaming.com
• Size: 166 KB
• Stars: 33
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Gradle Build](https://github.com/ChromasIV/KTweet/actions/workflows/gradle-build.yml/badge.svg?branch=master)](https://github.com/ChromasIV/KTweet/actions/workflows/gradle-build.yml) [![Gradle Tests](https://github.com/ChromasIV/KTweet/actions/workflows/gradle-tests.yml/badge.svg?branch=master)](https://github.com/ChromasIV/KTweet/actions/workflows/gradle-tests.yml) [![KTweet on Maven](https://img.shields.io/maven-metadata/v.svg?label=latest%20version&metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fchromasgaming%2Fktweet%2Fmaven-metadata.xml)](https://central.sonatype.com/artifact/com.chromasgaming/ktweet)

# KTweet - A Kotlin X/Twitter Library

KTweet is a library that allows you to use the X/Twitter API v2 using OAuth2.0.

Interested in Kotlin or KTweet? 

Join the [Discord](https://discord.gg/aSBXXkzb3f)

## Setup

1. Obtain the API keys from your X/Twitter Developer portal. Follow this [guide](https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api).

2. Save them locally and add them to your environment variables. 

3. Run [ManageTweetsTest.kt](src/test/kotlin/com/chromasgaming/ktweet/api/ManageTweetsAPITest.kt) to validate no issues.

## Contribution  

All contribution to the library is welcomed.

Ensure any request follows the following:

 - [Contributing](https://github.com/ChromasIV/KTweet/blob/master/CONTRIBUTING.md)

 - [Feature Request](https://github.com/ChromasIV/KTweet/blob/master/.github/ISSUE_TEMPLATE/feature_request.md)

 - [Bug Report](https://github.com/ChromasIV/KTweet/blob/master/.github/ISSUE_TEMPLATE/bug_report.md)

## License

   Copyright 2021 Thomas P. Carney

   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at

   

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.