Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daltoniam/swiftlog
Simple and easy logging in Swift.
https://github.com/daltoniam/swiftlog
Last synced: about 2 months ago
JSON representation
Simple and easy logging in Swift.
- Host: GitHub
- URL: https://github.com/daltoniam/swiftlog
- Owner: daltoniam
- License: mit
- Created: 2014-12-23T22:11:48.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-15T02:24:21.000Z (almost 6 years ago)
- Last Synced: 2024-11-09T05:33:58.500Z (about 2 months ago)
- Language: Swift
- Size: 28.3 KB
- Stars: 72
- Watchers: 4
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SwiftLog
========
Simple and easy logging in Swift.
## Features
- Super simple. Only one method to log.
- Rolled logs.
- Simple concise codebase at just at barely two hundred LOC.
First thing is to import the framework. See the Installation instructions on how to add the framework to your project.
```swift
import SwiftLog
```
## Example
SwiftLog can be used right out of the box with no configuration, simply call the logging function.
```swift
logw("write to the log!")
```
That will create a log file in the proper directory on both OS X and iOS.
OS X log files will be created in the OS X log directory (found under: /Library/Logs). The iOS log files will be created in your apps document directory under a folder called Logs.
## Configuration
There are a few configurable options in SwiftLog.
```swift
//This writes to the log
logw("write to the log!")
//Set the name of the log files
Log.logger.name = "test" //default is "logfile"
//Set the max size of each log file. Value is in KB
Log.logger.maxFileSize = 2048 //default is 1024
//Set the max number of logs files that will be kept
Log.logger.maxFileCount = 8 //default is 4
//Set the directory in which the logs files will be written
Log.logger.directory = "/Library/somefolder" //default is the standard logging directory for each platform.
//Set whether or not writing to the log also prints to the console
Log.logger.printToConsole = false //default is true
```
## Installation
### CocoaPods
Check out [Get Started](http://cocoapods.org/) tab on [cocoapods.org](http://cocoapods.org/).
To use SwiftLog in your project add the following 'Podfile' to your project
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
pod 'SwiftLog', '~> 1.0.0'
Then run:
pod install
### Carthage
Check out the [Carthage](https://github.com/Carthage/Carthage) docs on how to add a install. The `SwiftLog` framework is already setup with shared schemes.
[Carthage Install](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application)
### Rogue
First see the [installation docs](https://github.com/acmacalister/Rogue) for how to install Rogue.
To install SwiftLog run the command below in the directory you created the rogue file.
```
rogue add https://github.com/daltoniam/SwiftLog
```
Next open the `libs` folder and add the `SwiftLog.xcodeproj` to your Xcode project. Once that is complete, in your "Build Phases" add the `SwiftLog.framework` to your "Link Binary with Libraries" phase. Make sure to add the `libs` folder to your `.gitignore` file.
### Other
Simply grab the framework (either via git submodule or another package manager).
Add the `SwiftLog.xcodeproj` to your Xcode project. Once that is complete, in your "Build Phases" add the `SwiftLog.framework` to your "Link Binary with Libraries" phase.
### Add Copy Frameworks Phase
If you are running this in an OSX app or on a physical iOS device you will need to make sure you add the `SwiftLog.framework` included in your app bundle. To do this, in Xcode, navigate to the target configuration window by clicking on the blue project icon, and selecting the application target under the "Targets" heading in the sidebar. In the tab bar at the top of that window, open the "Build Phases" panel. Expand the "Link Binary with Libraries" group, and add `SwiftLog.framework`. Click on the + button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add `SwiftLog.framework`.
## License
SwiftLog is licensed under the MIT License.
## Contact
### Dalton Cherry
* https://github.com/daltoniam
* http://twitter.com/daltoniam
* http://daltoniam.com