Rtasklib

Coverage Status Coverage Status yard docs

Description

A Ruby wrapper around the TaskWarrior command line tool.

Installation

Add this line to your application's Gemfile:

gem 'rtasklib'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rtasklib

Dependencies

  • Taskwarrior > 2.4 (require custom UDAs, recurrences, and duration data types)

  • Ruby > 2.1 (Because default keyword arguments are too hard to live without :) )

  • See ./rtasklib.gemspec for the latest Ruby dependencies

Usage

require 'rtasklib'

tw = Rtasklib::TW.new('../path/to/.task')

# do some stuff with the task database
# available commands are documented in the Controller class

tw.all

Controller docs

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

License

Release under the MIT License (MIT) Copyright (©) 2015 Will Paul

Contributing

  1. Fork it ( https://github.com/[my-github-username]/rtasklib/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request