https://github.com/jojo4gh/kzip
Kotlin Multiplatform ZIP library
https://github.com/jojo4gh/kzip
io kotlin kotlin-library kotlin-multiplatform zip
Last synced: 2 months ago
JSON representation
Kotlin Multiplatform ZIP library
- Host: GitHub
- URL: https://github.com/jojo4gh/kzip
- Owner: Jojo4GH
- License: mit
- Created: 2024-10-01T23:47:14.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-03-23T00:52:43.000Z (3 months ago)
- Last Synced: 2025-03-23T01:27:26.106Z (3 months ago)
- Topics: io, kotlin, kotlin-library, kotlin-multiplatform, zip
- Language: C++
- Homepage:
- Size: 285 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kzip
[![Maven Central][kzip-maven-badge]][kzip-maven]
[![GitHub][kzip-license-badge]](LICENSE)
[![Kotlin Multiplatform][kotlin-multiplatform-badge]][kotlin-multiplatform]
[![JVM Platform][jvm-platform-badge]][kotlin-jvm]
[![Linux X64 Platform][linux-x64-platform-badge]][kotlin-native]
[![Linux ARM64 Platform][linux-arm64-platform-badge]][kotlin-native]
[![MinGW X64 Platform][mingw-x64-platform-badge]][kotlin-native]
[![Android X64 Platform][android-x64-platform-badge]][kotlin-native]
[![Android ARM64 Platform][android-arm64-platform-badge]][kotlin-native]
[kzip-maven-badge]: https://img.shields.io/maven-central/v/de.jonasbroeckmann.kzip/kzip?label=Latest
[kzip-license-badge]: https://img.shields.io/github/license/Jojo4GH/kzip?cacheSeconds=3600
[kotlin-multiplatform-badge]: https://img.shields.io/badge/Kotlin_Multiplatform-grey?logo=kotlin
[jvm-platform-badge]: https://img.shields.io/badge/Platform-JVM-4dbb5f
[linux-x64-platform-badge]: https://img.shields.io/badge/Native-Linux_X64-e082f3
[linux-arm64-platform-badge]: https://img.shields.io/badge/Native-Linux_ARM64-e082f3
[mingw-x64-platform-badge]: https://img.shields.io/badge/Native-MinGW_X64-e082f3
[android-x64-platform-badge]: https://img.shields.io/badge/Native-Android_X64-e082f3
[android-arm64-platform-badge]: https://img.shields.io/badge/Native-Android_ARM64-e082f3
[kzip-maven]: https://central.sonatype.com/artifact/de.jonasbroeckmann.kzip/kzip
[kotlin-multiplatform]: https://kotlinlang.org/docs/multiplatform.html
[kotlin-native]: https://kotlinlang.org/docs/native-overview.html
[kotlin-jvm]: https://kotlinlang.org/docs/jvm-get-started.html
A lightweight Kotlin Multiplatform library for reading, writing and modifying ZIP files.
## ⭐️ Main Features
- 🗂️ **Reading** ZIP entries and metadata
- 🗜️ Easy **extraction** and **compression** of files and directories
- 📝 **Modifying** existing ZIP files
The kotlin file I/O interface uses [kotlinx-io](https://github.com/Kotlin/kotlinx-io) making it compatible with other Kotlin Multiplatform libraries.
The JVM implementation uses the standard `java.util.zip` while the current native implementation uses the lightweight [kuba--/zip](https://github.com/kuba--/zip).
Currently kzip supports the following targets:
- `jvm`
- `linuxX64`
- `linuxArm64`
- `mingwX64`
- `androidNativeX64`
- `androidNativeArm64`
But the following targets are planned (mostly only requiring testing):
- All Apple targets
- `androidNativeX86`
- `androidNativeArm32`
More features are planned including support for suspending functions, more access to metadata, more utilities and integrations into other KMP libraries (see also [Contributing](#-contributing)).
## 🛠️ Installation
The kzip dependency is available on Maven Central and can be added to your common source set.
Just replace `$kzipVersion` with the [latest version](#kzip).
Gradle - Kotlin DSL
```kotlin
implementation("de.jonasbroeckmann.kzip:kzip:$kzipVersion")
```
Gradle - Groovy DSL
```groovy
implementation "de.jonasbroeckmann.kzip:kzip:$kzipVersion"
```
Maven
```xml
de.jonasbroeckmann.kzip
kzip
$kzipVersion
```
## 🚀 Usage
### Reading a ZIP file
```kotlin
val zip = Zip.open(Path("example.zip"))
// Access a specific entry
zip.entry(Path("content.txt")) {
println("Entry content.txt has size $uncompressedSize")
println("Entry content.txt has content:")
println(readToSource().readString())
}
// Access all entries
zip.forEachEntry { entry ->
println("Entry ${entry.path} has size ${entry.uncompressedSize}")
if (entry.isDirectory) {
println("Entry is a directory")
} else {
println("Entry is a file with content:")
println(entry.readToSource().readString())
}
}
zip.close()
```
### Extracting a ZIP file
```kotlin
Zip.open(Path("example.zip")).use { zip ->
zip.extractTo(Path("example"))
}
```
### Creating a ZIP file from a directory
```kotlin
Zip.open(
path = Path("example.zip"),
mode = Zip.Mode.Write,
// Optional: Set compression level
level = Zip.CompressionLevel.BetterCompression
).use { zip ->
zip.compressFrom(Path("example"))
}
```
### Modifying a ZIP file
```kotlin
val textSource = Buffer().apply { writeString("Hello, World!") }
Zip.open(Path("example.zip"), mode = Zip.Mode.Append).use { zip ->
// Add a folder
zip.folderEntry(Path("subfolder"))
// Add a file from a path
zip.entryFromPath(Path("compressed.txt"), Path("example.txt"))
// Add a file from a source
zip.entryFromSource(Path("hello_world.txt"), textSource)
}
textSource.close()
```
## 🚧 Contributing
If you have any ideas, feel free to open an issue or create a pull request.
## 📄 License
This project is licensed under the [MIT License](LICENSE).