kzip
1.1.1indexedLightweight library facilitates reading, writing, and modifying ZIP files, offering features like easy extraction, compression, and modification of ZIP entries and metadata.
20
Stars
—
Used by
dependents
—
Health
/ 100
Kzip
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 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.
Currently kzip supports the following targets:
jvmlinuxX64linuxArm64mingwX64androidNativeX64
But the following targets are planned (mostly only requiring testing):
- Other Apple targets
More features are planned including support for suspending functions, more access to metadata, more utilities and integrations into other KMP libraries (see also 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.
Gradle - Kotlin DSL
implementation("de.jonasbroeckmann.kzip:kzip:$kzipVersion")
Gradle - Groovy DSL
implementation "de.jonasbroeckmann.kzip:kzip:$kzipVersion"
Maven
<dependencies>
<dependency>
<groupId>de.jonasbroeckmann.kzip
kzip
$kzipVersion
🚀 Usage
Reading a ZIP file
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 has size ")
(entry.isDirectory) {
println()
} {
println()
println(entry.readToSource().readString())
}
}
zip.close()
Extracting a ZIP file
Zip.open(Path("example.zip")).use { zip ->
zip.extractTo(Path("example"))
}
Creating a ZIP file from a directory
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
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.