Copyright © David Jimenez Guinaldo & Guillermo Garcia Rebolo.

Licensy is an iOS drop-in class that allow you to display a table listing all the 3rd Party Libraries that you are using in your app, and preview some data about it's licenses and copyrights.

Requirements

Licensy works on iOS 9+ and requires ARC to build. It depends on the following Apple frameworks, which should already be included with most Xcode templates:

• Foundation.framework
• UIKit.framework

You will need the latest developer tools in order to build Licensy. Old Xcode versions might work, but compatibility will not be explicitly maintained.

Installation

CocoaPods is the recommended way to add Licensy to your project.

pod 'Licensy'

1. Install the pod(s) by running pod install.
2. Include Licensy wherever you need it with @import Licensy if your project is in Objective-C or import Licensy if your project is in Swift.

Usage

Basic usage of this library involves creating a UITableView with the class LicensyTable that provides our pod and adding the libraries included in your app.

'Libraries' Structure

A Library is an object containing all the information about the library being used and its license:

As you can tell from above the license is a property of type License, there are some of the more usually used and that Licensy provides:

Also you can create your custom license with the object class CustomLicense to build one license that is not listed above.

Add Libraries from objects

You can create yout library objects and provide them to the 'Licensy' table to list them. You can see the detailed examples in the example in this repository.

//Load tableView with an array on Library
let librariesArray: Array<LibraryEntity> = [
    LibraryEntity(name: "Library 1", organization: "RetoLabs", url: "[email protected]", copyright: "Guillermo Garcia Rebolo", license: MITLicense()),
    LibraryEntity(name: "Library 2", organization: "RetoLabs", url: "[email protected]", copyright: "David Jiménez Guinaldo", license: ApacheSoftwareLicense20()),
    LibraryEntity(name: "Library 3", organization: "RetoLabs", url: "[email protected]", copyright: "Guillermo Garcia Rebolo", license: GnuGeneralPublicLicense30()),
    LibraryEntity(name: "Library 4", organization: "RetoLabs", url: "[email protected]", copyright: "David Jiménez Guinaldo", license: GnuGeneralPublicLicense30())
]
tableView.setLibraries(librariesArray)

Add Libraries from JSON

You can list all of your libraries and their licenses in a json file included in your app bundle, with a format as such:

{
    "libraries": [
        {
            "name": "Licensy",
            "organization": "RetoLabs",
            "url": "https://github.com/guille969/Licensy",
            "copyright": "Copyright (C) 2017 RetoLabs",
            "license": "MIT"
        },
        {
            "name": "MGBottomSheet",
            "organization": "Guillermo Garcia Rebolo",
            "url": "https://github.com/guille969/MGBottomSheet",
            "copyright": "Copyright (C) 2017 Guillermo Garcia Rebolo",
            "license": "MIT"
        }
    ]
}

For use it you can call in your view controller the next code:

//libraries is the name of the JSON file in your project with your 3rd Party libraries
let path = Bundle.main.path(forResource: "libraries", ofType: "json")!
self.tableView.setLibraries(forJsonResourcePath: path)

or this other way, only providing the name of the JSON resource:

tableView.setLibraries(forJsonResourceName: "librerias")

Customize appearance

You are able to customize some style properties:

Example of customization:

tableView.appearance.accentColor = UIColor.red
tableView.appearance.roundLicenseButton = true
tableView.appearance.accesory = .plus
tableView.appearance.licenseSize = .extended

We provide you 3 different predefined styles:

Default style	iOS style	Orange fit

Applying a predefined style:

tableView.appearance.setIOSDefaultAppearance() //iOS style
tableView.appearance.setOrangeFitAppearance() //Orange fit