⌛️ Add beautiful progress bars to your loops.
Swift Objective-C Ruby
Latest commit 6b051e4 Oct 14, 2016 @jkandzi update podspec
Permalink
Failed to load latest commit information.
Progress.swift Jump build version to 0.2.0 Sep 20, 2016
Sources Convert to Swift-3.0. Sep 20, 2016
.gitignore add carthage support Dec 29, 2015
.travis.yml
LICENSE.txt
Package.swift
Progress.swift.podspec update podspec Oct 14, 2016
README.md fix type in filename Jan 11, 2016
demo.gif add demo gif Jan 11, 2016

README.md

Progress.swift ⌛️

Build Status codecov.io Carthage compatible SPM ready Version License Platform

demo gif

Just wrap the SequenceType in your loop with the Progress SequenceType and you'll automatically get beautiful progress bars.

Updating the progress bar does not work in the Xcode console because it does not support the cursor movements. If you want it to look nice run it in a real terminal.

Example

Just take a regular loop like this for i in 1...9 { ... and wrap the 1...9 range in the Progress type and you'll automatically get a nice progress bar.

import Progress

for i in Progress(1...9) {
    ...
}

Creates this output:

$ 4 of 9 [-------------                 ] ETA: 0:00:05 (at 1.01 it/s)

It also works with all the other types adopting the CollectionType protocol like dictionarys: Progress(["key": "value", "key2": "also value"]) and arrays: Progress([1, 52, 6, 26, 1]).

You can also create the progress bar manually without a sequence type:

var bar = ProgressBar(count: 4)

for i in 0...3 {
    bar.next()
    sleep(1)
}

Configuration

You can configure the progress bar by combining single building blocks of type ProgressElementType.

Either by setting a default configuration:

ProgressBar.defaultConfiguration = [ProgressString(string: "Percent done:"), ProgressPercent()]

which creates the following result:

$ Percent done: 80%

or by providing a specific configuration in the Process initializer:

Progress(0...10, configuration: [ProgressPercent(), ProgressBarLine(barLength: 60)])

resulting in something like this:

$ 100% [------------------------------------------------------------]

Available ProgressElementType elements:

  • ProgressBarLine (The actual bar. E.g. "[---------------------- ]").
  • ProgressIndex (The current index & overall count. E.g. "2 of 3").
  • ProgressPercent (The progress in percent. E.g. "60%").
  • ProgressTimeEstimates (Estimated time remaining & items per second. E.g. "ETA: 00:00:02 (at 1.00 it/s)").
  • ProgressString (Adds an arbitrary string to the progress bar).

Installation

Cocoapods

Progress.swift is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "Progress.swift"

Carthage

To integrate Progress.swift into your Xcode project using Carthage, specify it in your Cartfile:

github "jkandzi/Progress.swift"

Run carthage update to build the framework and drag the built Progress.framework into your Xcode project.

Swift Package Manager

To install with the Swift Package Manager, add the following in your Package.swift:

import PackageDescription

let package = Package(
    name: "MyProject",
    dependencies: [
        .Package(url: "https://github.com/jkandzi/Progress.swift", majorVersion: 0)
    ]
)

Manual

You can also copy the Progress.swift file into your Xcode project.

Contribution

You are welcome to fork and submit pull requests.

Author

Justus Kandzi, justus.kandzi@gmail.com

License

Progress.swift is available under the MIT license. See the LICENSE file for more info.