https://github.com/marmelroy/zip

Swift framework for zipping and unzipping files.
https://github.com/marmelroy/zip

compression files swift unzip zip

Last synced: 6 days ago
JSON representation

Swift framework for zipping and unzipping files.

• Host: GitHub
• URL: https://github.com/marmelroy/zip
• Owner: marmelroy
• License: mit
• Created: 2015-12-13T18:34:14.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T18:42:46.000Z (5 months ago)
• Last Synced: 2024-12-17T08:03:32.250Z (6 days ago)
• Topics: compression, files, swift, unzip, zip
• Language: Swift
• Homepage:
• Size: 7.97 MB
• Stars: 2,517
• Watchers: 43
• Forks: 454
• Open Issues: 111
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Zip - Zip and unzip files in Swift](https://cloud.githubusercontent.com/assets/889949/12374908/252373d0-bcac-11e5-8ece-6933aeae8222.png)

[![Build Status](https://travis-ci.org/marmelroy/Zip.svg?branch=master)](https://travis-ci.org/marmelroy/Zip) [![Version](http://img.shields.io/cocoapods/v/Zip.svg)](http://cocoapods.org/?q=Zip) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![SPM supported](https://img.shields.io/badge/SPM-supported-brightgreen.svg?style=flat)](https://swift.org/package-manager)

# Zip

A Swift framework for zipping and unzipping files. Simple and quick to use. Built on top of [minizip](https://github.com/nmoinvaz/minizip).

## Usage

Import Zip at the top of the Swift file.

```swift

import Zip

```

## Quick functions

The easiest way to use Zip is through quick functions. Both take local file paths as NSURLs, throw if an error is encountered and return an NSURL to the destination if successful.

```swift

do {

    let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!

    let unzipDirectory = try Zip.quickUnzipFile(filePath) // Unzip

    let zipFilePath = try Zip.quickZipFiles([filePath], fileName: "archive") // Zip

}

catch {

  print("Something went wrong")

}

```

## Advanced Zip

For more advanced usage, Zip has functions that let you set custom  destination paths, work with password protected zips and use a progress handling closure. These functions throw if there is an error but don't return.

```swift

do {

    let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!

    let documentsDirectory = FileManager.default.urls(for:.documentDirectory, in: .userDomainMask)[0]

    try Zip.unzipFile(filePath, destination: documentsDirectory, overwrite: true, password: "password", progress: { (progress) -> () in

        print(progress)

    }) // Unzip

    let zipFilePath = documentsFolder.appendingPathComponent("archive.zip")

    try Zip.zipFiles([filePath], zipFilePath: zipFilePath, password: "password", progress: { (progress) -> () in

        print(progress)

    }) //Zip

}

catch {

  print("Something went wrong")

}

```

## Custom File Extensions

Zip supports '.zip' and '.cbz' files out of the box. To support additional zip-derivative file extensions:

```swift

Zip.addCustomFileExtension("file-extension-here")

```

### [Preferred] Setting up with [Swift Package Manager](https://swift.org/package-manager)

To use Zip with Swift Package Manager, add it to your package's dependencies:

```swift

.package(url: "https://github.com/marmelroy/Zip.git", .upToNextMinor(from: "2.1"))

```

### Setting up with [CocoaPods](http://cocoapods.org/?q=Zip)

```ruby

source 'https://github.com/CocoaPods/Specs.git'

pod 'Zip', '~> 2.1'

```

### Setting up with [Carthage](https://github.com/Carthage/Carthage)

To integrate Zip into your Xcode project using Carthage, specify it in your `Cartfile`:

```ogdl

github "marmelroy/Zip" ~> 2.1

```