wmontwe / hc-util-sdk-kmp

Data4Life Util SDK

This is the Util SDK that provides basic definition and implementation of e.g. Base64, Sha1-hash, MIME types and data size restriction.

Explore the docs »

Report Bug · Request Feature

Table Of Contents

• About The Project
  • Features
  • Dependencies
  • Built With
• Getting Started
  • Requirements
• Installation
  • util
• Roadmap
• Changelog
• Versioning
• Contributing
• Copyright and License

About The Project

The Util SDK is a collection of tools and definitions that are reused across different projects at Data4Life. Currently we support Android, JVM and iOS, which can be conveniently consumed by Kotlin common code.

Features

util

• Base64 encoding/decoding

• SHA1-HASH calculation

• MIME type helpers

• Logger

• Platform restrictions

error

• D4LRuntimeException

• D4LException

Dependencies

The SDK has the following dependencies:

• AndroidX Annotation (Android only)

Built With

• Kotlin Multiplatform

Getting Started

Requirements

• Java 11 | Limitations of Java language features and APIs | Desugaring

• Kotlin 1.7.10

• Android 6.0 (API 23) to Android 13.0 (API 33)

Installation

Add the following maven repository url to your root build.gradle:

allprojects {
    repositories {
        ...
        maven {
            url = URI("https://maven.pkg.github.com/d4l-data4life/hc-util-sdk-kmp")
            credentials {
                username = project.findProperty("gpr.user") as String? ?: System.getenv("PACKAGE_REGISTRY_USERNAME")
                password = project.findProperty("gpr.key") as String? ?: System.getenv("PACKAGE_REGISTRY_TOKEN")
            }
        }
    }
}

Your GitHub username and token needs to be stored in your global Gradle properties: ~/.gradle/gradle.properties

NOTICE

You need to have read access to this repository and generate a personal access token with repo, write:packages and read:packages scope.

gpr.user=github-username
gpr.key=github-token

util

Add following dependencies to your app build.gradle.

dependencies {
    implementation "care.data4life.hc-util-sdk-kmp:util:$version"
}

Roadmap

This project is work in progress. We are working on adding more functionality, guidelines, documentation and other improvements.

Changelog

See changelog

Versioning

We use Semantic Versioning as a guideline for our versioning.

Releases use this format: {major}.{minor}.{patch}

• Breaking changes bump {major} and reset {minor} & {patch}

• Backward compatible changes bump {minor} and reset {patch}

• Bug fixes bump {patch}

Contributing

You want to help or share a proposal? You have a specific problem? Read the following:

• Code of conduct for details on our code of conduct.

• Contributing for details about how to report bugs and propose features.

• Developing for details about our development process and how to build and test the project.

Copyright and License

Copyright (c) 2022 D4L data4life gGmbH / All rights reserved. Please refer to our License for further details.