Kotlin/api-guidelines

Stars
144
Rank 255,590 (Top 6 %)
Language
License
Apache License 2.0
Created over 1 year ago
Updated 2 months ago

Kotlin/api-guidelines

Kotlin

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Best practices to consider when writing an API for your library

Kotlin API guidelines

This guide contains a summary of best practices as well as some ideas to consider when writing an API for your library.

The guide is mostly authored by the Kotlin Libraries team, and is based on the practices the team follows when developing and maintaining Kotlin standard and official libraries.

You can read it at kotl.in/api-guide

Discussion

You are welcome to join the discsussion about existing guidelines or to propose a new one. Feel free to join the discussions or submit your requests to issues.

Contributing

See Contribution Guidelines

anko

Pleasant Android application development

kotlinx.coroutines

Library support for Kotlin coroutines

kotlinx.serialization

Kotlin multiplatform / multi-format serialization

dokka

API documentation engine for Kotlin

kotlin-examples

Various examples for Kotlin

KEEP

Kotlin Evolution and Enhancement Process

kotlin-koans

Kotlin workshop

kotlinx-datetime

KotlinX multiplatform date/time library

kmp-production-sample

This is an open-source, mobile, cross-platform application built with Kotlin Multiplatform Mobile. It's a simple RSS reader, and you can download it from the App Store and Google Play. It's been designed to demonstrate how KMM can be used in real production projects.

kotlindl

High-level Deep Learning Framework written in Kotlin and inspired by Keras

coroutines-examples

Examples for coroutines design in Kotlin

kotlinx-kover

kotlin-fullstack-sample

Kotlin Full-stack Application Example

kotlinx.collections.immutable

Immutable persistent collections for Kotlin

kotlin-jupyter

Kotlin kernel for Jupyter/IPython

kotlinx-cli

Pure Kotlin implementation of a generic CLI parser.

kmm-basic-sample

Example of Kotlin multiplatform project

dataframe

Structured data processing in Kotlin

kotlinx-io

Kotlin multiplatform I/O library

binary-compatibility-validator

Public API management tool

kotlinx-rpc

Add asynchronous RPC services to your multiplatform applications.

kotlinx-atomicfu

The idiomatic way to use atomic operations in Kotlin

kotlinconf-spinner

workshop

JetBrains Kotlin Workshop Material

kotlin-interactive-shell

Kotlin Language Interactive Shell

kdoctor

Environment analysis tool

kandy

Kotlin plotting library.

kotlin-frontend-plugin

Gradle Kotlin (http://kotlinlang.org) plugin for frontend development

dukat

Converter of <any kind of declarations> to Kotlin external declarations

multik

kotlin-wasm-examples

Examples with Kotlin/Wasm

kotlinx-benchmark

Kotlin multiplatform benchmarking toolkit

kotlin-spark-api

This projects gives Kotlin bindings and several extensions for Apache Spark. We are looking to have this as a part of Apache Spark 3.x

kotlin-by-example

The sources of Kotlin by Example.

kotlin-spec

Kotlin Language Specification:

kotlin-in-action

Code samples from the "Kotlin in Action" book

ts2kt

ts2kt is officially deprecated, please use https://github.com/Kotlin/dukat instead. // Converter of TypeScript definition files to Kotlin external declarations

kotlin-numpy

Kotlin bindings for NumPy

kotlin-style-guide

Work-in-progress notes for the Kotlin style guide

kotlinx-knit

Kotlin source code documentation management tool

anko-example

A small application built with Anko DSL

full-stack-web-jetbrains-night-sample

Full-stack demo application written with Kotlin MPP

KMP-App-Template

Kotlin Multiplatform app template with shared UI

kotlin-script-examples

Examples of Kotlin Scripts and usages of the Kotlin Scripting API

kotlinx-nodejs

Kotlin external declarations for using the Node.js API from Kotlin code targeting JavaScript

kotlin-eclipse

Kotlin Plugin for Eclipse

Storytale

kotlinx.reflect.lite

Lightweight library allowing to introspect basic stuff about Kotlin symbols

kotlin-benchmarks

This is the project to verify and investigate performance issues in Kotlin and standard library.

kotlin-libs-publisher

Gradle plugin for publishing of Kotlin libs

kotlinx-browser

Kotlin browser API

kotlindl-app-sample

This repo demonstrates how to use KotlinDL for neural network inference on Android devices.

kotlin-koans-edu

Kotlin Koans for Educational Plugin and play.kotl.in

KMP-App-Template-Native

Kotlin Multiplatform app template with native UI

grammar-tools

Tokenization and parsing Kotlin code using the ANTLR Kotlin grammar

kmm-integration-sample

kmm-with-cocoapods-sample

This project represents the case when Cocoapods dependencies are added in Kotlin and there is no existing Xcode project

kotlin-koans-edu-obsolete

Obsolete: check https://github.com/Kotlin/kotlin-koans-edu for the latest version.

kotlin-native-calculator-sample

kotlinx.support

Extension and top-level functions to use JDK7/JDK8 features in Kotlin 1.0

js-externals

External declarations for Kotlin/JS

k2-performance-metrics

Measure Kotlin K2 compiler performance in your repository

Jupyter Notebook

kmp-native-wizard

A mostly-empty template to get started creating a Kotlin/Native project.

coroutines-workshop

Materials for a full-day workshop on Kotlin Coroutines

swift-export-sample

Kotlin to Swift technology preview

kotlin-playground-wp-plugin

WordPress plugin which allows to embed interactive Kotlin playground to any post via [kotlin] shortcode

io2019-serverside-demo

kotlin-jupyter-libraries

Library descriptors for Kotlin kernel for Jupyter

kmm-with-cocoapods-multitarget-xcode-sample

This project is intended to demonstrate how to connect Kotlin library to Xcode project with several targets: iOS, macOS, tvOS, watchOS

xcode-compat

AppCode helper for Kotlin/Native and Xcode

kotlin-in-action-2e

Code samples for the second edition of "Kotlin in Action".

kotlin-wasm-compose-template

A template repository for Compose Multiplatform with Kotlin/Wasm target

kotlinx.dom

kotlin-wasm-benchmarks

Kotlin Multiplatform Collection of Benchmarks focused on Kotlin/Wasm performance

dokka-plugin-template

Dokka plugin quickstart template with pre-configured dependencies and publishing

kotlinx.team.infra

multiplatform-library-template

kotlin-js-inspection-pack-plugin

Adds useful inspections, intentions, and quick-fixes for working with Kotlin/JS projects.

obsolete-kotlin-swing

Experimental library providing some helper functions and extensions for creating Swing user interfaces.

kotlin-in-action-2e-jkid

Sample project accompanying the second edition of "Kotlin in Action". JSON serialization/deserialization library for Kotlin data classes

kotlin-wasm-browser-template

A template repository for Kotlin/Wasm on browser

kotlin-spark-shell

Kotlin Language support for Apache Spark

obsolete-kotlin-jdbc

Experimental library providing some helper functions and extensions for working with JDBC in Kotlin.

community-project-gradle-plugin

website-grammar-generator

Kotlin ANTLR grammar converter to XML for the Kotlin website or text file

kotlin-grammar-gpl2

Kotlin grammar ANTLR sources (under GPLv2)

web-site-samples

Examples repository for kotlinlang.org

kotlin-build-report-sample

kotlin-wasm-wasi-template

A template repository for Kotlin/Wasm with WASI

kotlin-jupyter-http-util

Ktor client and serialization for Kotlin Jupyter Notebooks

kotlin-cocoapods-spec

analysis-api

Kotlin Analysis API Documentation

kotlin.github.io

Redirect to kotlinlang.org and favicon/title provider for kotlin.github.io/* websites.

kotlin-wasm-nodejs-template

A template repository for Kotlin/Wasm on Node.js

kmm-with-cocoapods-xcode-two-kotlin-libraries-sample

This project is intended to demonstrate the connection of two Kotlin libraries to existing Xcode project through Cocoapods