Sha256: 1f9ce1383c3af09eb24075e651312e2206b5a8f91f24e2de5c6996febd4ec822
Contents?: true
Size: 1.42 KB
Versions: 16
Compression:
Stored size: 1.42 KB
Contents
# Kagu
Ruby API to manage macOS Music tracks and playlists.
**Important note for macOS Catalina (10.15) users**: Apple dropped automatic
XML library export you need to manually export your XML library to
`$HOME/Music/iTunes/iTunes Music Library.xml` path to make `kagu` work
properly.
## Installation
Just add this into your `Gemfile`:
```ruby
gem 'kagu'
```
Then, just run `bundle install`.
## Examples
### Displaying all tracks artist
```ruby
library = Kagu::Library.new
library.tracks.each do |track|
puts track.artist
end
```
### Displaying all playlists and its tracks count
```ruby
library = Kagu::Library.new
library.playlists.each do |playlist|
puts "#{playlist.name}: #{playlist.tracks.count}"
end
```
### Creating a playlist
```ruby
library = Kagu::Library.new
tracks = library.tracks.select { |track| track.genre == 'Drum & Bass' && track.added_at > 1.week.ago }
library.playlists.create(name: 'Recent - D&B', tracks: tracks)
```
### Finding some tracks
```ruby
library = Kagu::Library.new
library.finder.find(artist: 'Serial Killaz', title: 'Walk and Skank').each do
puts track.id
end
```
### Configuring logger
In order to have some debug informations about what kagu does, you could
configure its logger:
```ruby
Kagu.logger = Logger.new(STDERR)
```
## Executing test suite
This project is fully tested with [Rspec 3](http://github.com/rspec/rspec).
Just run `bundle exec rake` (after a `bundle install`).
Version data entries
16 entries across 16 versions & 1 rubygems