https://github.com/hbmartin/objective-sdk-kotlin-multiplatform
https://github.com/hbmartin/objective-sdk-kotlin-multiplatform
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hbmartin/objective-sdk-kotlin-multiplatform
- Owner: hbmartin
- License: apache-2.0
- Created: 2024-08-05T03:08:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-16T11:54:53.000Z (10 months ago)
- Last Synced: 2025-03-30T23:43:02.632Z (6 months ago)
- Language: Kotlin
- Homepage: https://central.sonatype.com/artifact/me.haroldmartin/objective-sdk
- Size: 413 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Objective Kotlin Multiplatform SDK
[](https://github.com/hbmartin/objective-sdk-kotlin-multiplatform/actions/workflows/lint-and-test.yml)
[](https://www.codefactor.io/repository/github/hbmartin/objective-sdk-kotlin-multiplatform)
[](https://sonarcloud.io/summary/new_code?id=hbmartin_objective-sdk-kotlin-multiplatform)
[](https://hbmartin.github.io/objective-sdk-kotlin-multiplatform/index.html)
[](https://central.sonatype.com/artifact/me.haroldmartin/objective-sdk)
* [Install and run the CLI / TUI](#install-and-run-the-cli-tui)
* [Install and use the SDK library](#install-and-use-the-sdk-library)
+ [Add a dependency to your `build.gradle.kts` file:](#add-a-dependency-to-your-buildgradlekts-file)
+ [Instantiate the SDK](#instantiate-the-sdk)
+ [Get an object](#get-an-object)
* [Java / Spring Usage](#java-spring-usage)
* [iOS Usage](#ios-usage)
* [API Documentation](#api-documentation)
* [Contributing](#contributing)
* [Authors](#authors)
* [Legal](#legal)
## Install and run the CLI / TUI
Clone this repository to run the CLI / TUI or install with Homebrew.
```shell
# Set your API key
export OBJECTIVE_KEY=sk_...
# Install with homebrew
brew install hbmartin/objective/objective
# Checklist of commands
objective -h
# To start the interactive TUI
objective
# Optional alias
alias obj="objective"
echo 'alias obj="objective"' >> ~/.zshrc
```
## Install and use the SDK library
### Add a dependency to your `build.gradle.kts` file:
(To add the dependency to non-Gradle projects see the snippets on [Maven Central](https://central.sonatype.com/artifact/me.haroldmartin/objective-sdk).)
```kotlin
implementation("me.haroldmartin:objective-sdk:0.3.2")
```
If Gradle cannot find the Objective artifact then check that `mavenCentral()` is in your `repositories`.
### Instantiate the SDK
```kotlin
import me.haroldmartin.objective.ObjectiveClient
// To get your API key, sign up at https://objective.ai and paste it below
val objectiveKey = "sk_qwerty"
// To retrieve your key from an environment variable, use:
// val objectiveKey = System.getenv("OBJECTIVE_KEY")
val client = ObjectiveClient(objectiveKey)
```
### Get an object
```kotlin
import kotlinx.serialization.json.JsonObject
// Note that the generic can be any @Serializable object
// https://ktor.io/docs/client-serialization.html#receive_send_data
// It is strongly suggested you use nullable types to avoid deserialization errors
val obj = client.getObject("objectId")
```
## Java / Spring Usage
ObjectiveClient methods are `suspend`ing (async) and so require the explicit use of [continuations](https://www.baeldung.com/kotlin/suspend-functions-from-java) in Java.
For an example see this [Spring Boot demo](https://github.com/hbmartin/springboot-demo/blob/main/src/main/java/com/example/demo/DemoApplication.java#L28).
## iOS Usage
This library is compatible with Kotlin Multiplatform and can be used in iOS projects. The client methods can either be called as `async` methods or using completion handlers. To call it from Swift, use the following:
```swift
let client = ObjectiveClientInit.shared.withKey(apiKey: "sk_DVkOBubJN3lr")
client.getIndexes { indexes, error in
if error != nil {
print("failed to getObjects: \(error)")
}
if let indexes {
...
}
}
```
## API Documentation
All of the client calls available are [documented here](https://hbmartin.github.io/objective-sdk-kotlin-multiplatform/objective/me.haroldmartin.objective/-objective-client/index.html)
and the model used in responses are documented for [index calls](https://hbmartin.github.io/objective-sdk-kotlin-multiplatform/objective/me.haroldmartin.objective.models.index/index.html)
and [object calls](https://hbmartin.github.io/objective-sdk-kotlin-multiplatform/objective/me.haroldmartin.objective.models.obj/index.html).
## Contributing
* Jump in and modify this project! Start by cloning it with `git clone git@github.com:hbmartin/objective-sdk-kotlin-multiplatform.git`, then open it in IntelliJ and run the tests.
* [PRs](https://github.com/hbmartin/objective-sdk-kotlin-multiplatform/pulls) and [bug reports / feature requests](https://github.com/hbmartin/objective-sdk-kotlin-multiplatform/issues) are all welcome!
* This project is linted with [ktlint](https://github.com/pinterest/ktlint) and statically checked with [detekt](https://github.com/detekt/detekt)
* Treat other people with helpfulness, gratitude, and consideration! See the [JetBrains CoC](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct)
## Authors
* [Harold Martin](https://www.linkedin.com/in/harold-martin-98526971/) - harold.martin at gmail
## Legal
* This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE.txt) file for details
* “Objective” and any associated logos are the trademarks of Objective AI, Inc. (“Objective Trademarks”). All right, title, and interest, including all intellectual property rights, in the Platform, APIs, Service, AI Models, and Resultant Data (collectively, “Objective IP”) are owned by Objective AI, Inc.