storyboard-client

Crates.iostoryboard-client
lib.rsstoryboard-client
version0.2.1
sourcesrc
created_at2018-10-14 23:48:43.884899
updated_at2018-10-16 20:04:52.785829
descriptionA client for StoryBoard API
homepagehttps://github.com/ericho/storyboard-client
repositoryhttps://github.com/ericho/storyboard-client
max_upload_size
id90239
size20,276
Erich Cordoba (ericho)

documentation

README

Storyboard client

Linux build status

This little project is an attempt to write a storyboard api client.

Currently only the basic operations are supported and just for querying. In the future we might consider to perform write/delete operations.

Usage

Add this to your Cargo.toml

[dependencies]
storyboard_client = "*"

and this into your code:

extern crate storyboard_client;

Example

A simple example to search all the stories with the keyword stx.

extern crate storyboard_client;

use storyboard_client::Client;

fn main() {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let stories = client.search_stories("stx").unwrap();
    for s in &stories {
        println!("{} - {}", s.id, s.title);
    }
}

See more examples in the examples folder.

TODO

  • Add serialization for enums for task or story status.
  • Add failure crate.
  • Add search story by tag capability.
  • Change tests to not use network. (yes.. doc tests connects to openstack's API)
Commit count: 13

cargo fmt