Giter Club home page Giter Club logo

kindlekit's Introduction

KindleKit

KindleKit is a micro iOS Dynamic Framework with the single purpose of parsing user's notes and hightlights from Kindle eBook Reader generated 'CSV' files. These csv files user receives when he decides to export its Notes. Then Amazon sends email to user's email containing its notes in csv and pdf files.

Build using Swift 4.2, Xcode 10, supports iOS 11.0+

Usage

  1. import module KindleKit in the file you want to use the framework
  2. Invoke the static function KindleKit.parse(kindleCSV: String) passing the csv string.
  3. In return you will receive KindleKit.NotesContainer which is object that contains all data from this csv if it is in valid format.

Example

import UIKit
import KindleKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        guard let parsed = try? KindleKit.parse(kindleCSV: csvString) else { return }
        print(parsed)
    }
}


Installation

Carthage Installation

  1. In your Cartfile add github "stoqn4opm/KindleKit"
  2. Link the build framework with the target in your XCode project

For detailed instructions check the official Carthage guides here

Manual Installation

  1. Download the project and build the shared target called KindleKit
  2. Add the product in the list of "embed frameworks" list inside your project's target or create a work space with KindleKit and your project and link directly the product of KindleKit's target to your target "embed frameworks" list

Licence

The framework is licensed under MIT licence. For more information see file LICENCE

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.