Skip to content

sportstalk247/sdk-multiplatform

Repository files navigation

Maven Central Documentation Status

Sportstalk247 SDK Multiplatform

First, you need to register SportsTalk API with 'Appkey' and 'Token'. You need to visit the dashboard with the following URL:

https://dashboard.sportstalk247.com

  • Then click on ''Application Management'' link to generate the above

Setup Gradle Repository

The SportsTalk SDK is published on Maven Central.

In order to use it in your application, do the following:

  1. Add the following in root build.gradle file

For Groovy:

allprojects {
    repositories {
        // ...
        mavenCentral()
        maven {
            url "https://s01.oss.sonatype.org/content/repositories/snapshots/"
        }
        // ...
    }
}

For Kotlin DSL:

// ...
dependencyResolutionManagement {
    repositories {
        // ...
        google()
        mavenCentral()
        maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
        // ...
    }
}
// ...
  1. Add the following lines in your module build.gradle file:

For Groovy:

implementation 'io.github.sportstalk247.sdk-multiplatform:core:X.Y.Z'

For Kotlin DSL:

implementation("io.github.sportstalk247.sdk-multiplatform:core:X.Y.Z")

Maven Central

Then sync again. The gradle build should now be successful.

Publish to Maven using Nexus Publishing

Must provide the following config values under local.properties:

### KeyId, Password, and Signing Key will be used as params for useInMemoryPgpKeys()
signing.keyId=
signing.password=
signing.key=
### OSSRH Username and Password are your Sonatype Account Credentials
ossrhUsername=
ossrhPassword=

To create Sonatype account, proceed to https://central.sonatype.com/. Also, you may need to download GPG Keychain App to allow your workstation to publish an artifact. See the Gradle Nexus publish-plugin Github Repo for more info.

Documentation

Full SDK documentation found here: https://sportstalk247-sdk-multiplatform.readthedocs.io/en/latest/

If you want to generate the SDK documentation locally:

# install Python3
# setup pip3 virtual environment
# pip3 install sphinx-doc==7.4.7
#   - There are dependency issues on sphinx version 8.x, so we'll stick to 7.x for now 
#  
export PYTHON_SITE_PACKAGES=path/to/python/site-packages
# Change directory to `sdk-android-kotlin/docs` 
cd path/to/sdk-android-kotlin/docs
# Execute build
make html