https://github.com/tomasf/zip

Miniz-based Zip archive library for Swift
https://github.com/tomasf/zip

swift zip

Last synced: 2 days ago
JSON representation

Miniz-based Zip archive library for Swift

• Host: GitHub
• URL: https://github.com/tomasf/zip
• Owner: tomasf
• License: other
• Created: 2024-12-09T13:19:31.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2025-01-17T14:23:27.000Z (20 days ago)
• Last Synced: 2025-01-17T15:37:08.775Z (20 days ago)
• Topics: swift, zip
• Language: C
• Homepage:
• Size: 107 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zip

Zip is a lightweight cross-platform Swift package for working with Zip archives. It's built on top of [Miniz](https://github.com/richgel999/miniz) and includes its entire implementation, so no external dependencies are required.

Zip runs on Linux, Windows and all Apple platforms.

[![Swift](https://github.com/tomasf/Zip/actions/workflows/swift.yml/badge.svg)](https://github.com/tomasf/Zip/actions/workflows/swift.yml) ![Platforms](https://img.shields.io/badge/Platforms-macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS_%7C_Linux_%7C_Windows-47D?logo=swift&logoColor=white)

## Features

- Add and read files from ZIP archives.

- Support for both file-based and in-memory archives.

- Iterative reading of files in chunk.

- Configurable compression levels.

- Minimalistic and modern Swift API.

## Installation

Add the package to your project using Swift Package Manager. In your `Package.swift` file:

```swift

dependencies: [

    .package(url: "https://github.com/tomasf/Zip.git", from: "2.0.0")

]

```

## Examples

### Making a new memory-based archive

```swift

let archive = ZipArchive()

try archive.addFile(at: "content.json", data: jsonData)

let zipData = try archive.finalize()

```

### Reading from an existing archive in memory

```swift

let newArchive = try ZipArchive(data: zipData)

let data = try archive.fileContents(at: "hello.txt")

if let text = String(data: data, encoding: .utf8) {

    print("Hello.txt contains: \(text)")

}

```

### Writing a file-based archive

```swift

let archive = try ZipArchive(url: archiveURL)

try archive.addFile(at: "hello.txt", data: Data("Hello, Zip!".utf8))

try archive.finalize() // Writes Zip data to disk

```

## Contributions

Contributions are welcome! If you have ideas, suggestions, or bug reports, feel free to open an issue on GitHub. Pull requests are also appreciated.

## License

This project is licensed under the MIT License. See the LICENSE file for details.