Skip to content
This repository has been archived by the owner on Jun 13, 2019. It is now read-only.

Latest commit

 

History

History
128 lines (87 loc) · 3.94 KB

README.md

File metadata and controls

128 lines (87 loc) · 3.94 KB

Dotzu

In-App iOS Debugging Tool With Enhanced Logging, Networking Info, Crash reporting And More.

Platform iOS

Carthage compatible

License MIT

Codacy Badge

The debugger tool for iOS developer. Display logs, network request, device informations, crash logs while using the app. Easy accessible with its bubble head button 🔘. Easy to integrate in any apps, to handle development or testing apps easier. First version, there is plenty of room for improvement.

👉 Objective-c example 🐢


Usage

In the AppDelegate instanciate Dotzu manager. Be careful to use Dotzu for development purpose only.

   func application(_ application: UIApplication,
   didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        #if DEBUG
            Dotzu.sharedManager.enable()
        #endif
        return true
   }

Logs

Dotzu override print, so you can use it and see your logs. otherwise, you can add level, and get more details (file, and line) about your logs. With the Logger class provided by the framework. Get new logs count on the badge, or warning/error notification on the bubble head.

print("logs")
Logger.verbose("some logs")
Logger.info("infos")
Logger.warning("warning ! ⚠️")
Logger.error("error ❌")

Network

Dotzu use URLProcotol to logg the request. Can can add the logger on a custom URLSessionConfiguration. Works with Alamofire. Works by default with URLSession.shared. You can disabled the networking logging in the settings screen. Get notified by a 🚀, when a request is launched.

//Your custom configuration
let configuration = URLSessionConfiguration.default

///Add the network logger on the configuration
Dotzu.sharedManager.addLogger(session: configuration)

//Use it:
//For Alamofire
let sessionManager = Alamofire.SessionManager(configuration: configuration)

//For URLSession
let session = URLSession(configuration: configuration)

Installation

You can use CocoaPods to install Dotzu by adding it to your Podfile:

platform :ios, '9.0'
use_frameworks!
pod 'Dotzu'

For Objective-c use :

pod 'DotzuObjc'

Add this to your Cartfile:

github "remirobert/Dotzu"

Manually

Drag the source files into your project.

Installation - Objective-c

You can use CocoaPods to install DotzuObjc by adding it to your Podfile:

platform :ios, '9.0'
use_frameworks!
pod 'DotzuObjc'

Contact

License

Dotzu is released under the MIT License.