Project

kanbantool

0.0
No commit activity in last 3 years
No release in over 3 years
Easy access to Kanban Tool's API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.3
~> 5.0.0
>= 0
~> 2.4.0
< 1.10.0

Runtime

~> 0.11.0
 Project Readme

Kanban Tool

A Ruby wrapper library for accessing the Kanban Tool API.

Note: this is currently a limited, read-only interface. Contributions to extend the functionality are welcome.

Installation

Add this line to your application's Gemfile:

gem 'kanbantool'

And then execute:

bundle

Or install it yourself as:

gem install kanbantool

Usage

Make sure you have an API key, then create a client:

client = KanbanTool::Client.new(SUBDOMAIN, API_KEY}

You can then call methods on the client to retrieve data from the API:

# Retrieve an array of all boards under this account
client.boards #=> [#<KanbanTool::Board:0x00 ...>, ...]

# Retrieve a single board, including stages
client.board(BOARD_ID) #=> #<KanbanTool::Board:0x00 ...>

# Retrieve an array of all tasks for a specific board
client.tasks(BOARD_ID) #=> [#<KanbanTool::Task:0x00 ...>, ... ]

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes and tests (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request