Feel free to open PRs for features you miss, please remember keeping API minimalistic, predictable and self-explanatory.

🗂 CSV ️

Small, fast and convenient multiplatform CSV parser and builder written for one of my projects, and then shared with awesome Kotlin community.

Usage

There is no documentation for the API which consists of just three methods:

// Build CSV object using simple DSL
val csv = buildCsv {
    row {
        value("Code")
        value("Name")
    }
    row {
        value("DE")
        value("Germany")
    }
    row {
        value("BY")
        value("Belarus")
    }
}

// Export CSV object to CSV text
val csvText = csv.toCsvText()

// Parse CSV text to get a CSV object
val csv2 = Csv.parseText(csvText)

// Data structure
val allRows: List<Row> = csv2.rows
val header: HeaderRow = csv2.header
val data: List<DataRow> = csv2.data

// Transform CSV
val codes = data.map { it.value("Code") } // ["DE", "BY"]
val names = data.map { it.value("Name") } // ["Germany", "Belarus"]

Dependencies

In gradle/libs.versions.toml

[versions]
kotlin = "2.0.21"
csv = "0.14"

[libraries]
csv = { module = "de.halfbit:csv", version.ref = "csv" }

[plugins]
kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }

In shared/build.gradle.kts

plugins {
    alias(libs.plugins.kotlin.multiplatform)
}

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation(libs.csv)
        }
    }
}

Releasing

1. Bump version in build.gradle.kts of the root project
2. ./gradlew clean build publishAllPublicationsToCentralRepository

Release Notes

• 0.14 Add linuxArm64 target, update to Kotlin 2.0.21
• 0.13 Some API changes and DataRow.replaceValue(), see PR #13 for details
• 0.12 Add HeaderRow and DataRow types, enabling easier data transformations
• 0.11 Update to Kotlin 2.0.20
• 0.10 Migrate to the Apache 2.0 license
• 0.9 Improve performance of CSV generation (PR #4)
• 0.8 Update to Kotlin 2.0.0
• 0.7 Fixed issue #1
• 0.6 Fixed parsing of CRLF files, update to Kotlin 1.9.22
• 0.5 Updated to Kotlin 1.9.20
• 0.4 Fixed description of maven artifacts
• 0.3 Fixed typos in method names
• 0.2 Initial release

License

Copyright 2023-2024 Sergej Shafarenka, www.halfbit.de

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.