quandl

Crates.ioquandl
lib.rsquandl
version0.1.1
sourcesrc
created_at2015-12-09 20:47:03.113309
updated_at2015-12-12 23:55:19.918092
descriptionA rust library for calling the Quandl API.
homepage
repositoryhttps://github.com/frostly/quandl
max_upload_size
id3603
size34,608
Icelle (Icelle)

documentation

http://open.frostly.com/quandl

README

Quandl

Travis Build Status Coverage Status MIT licensed Apache licensed crates.io

Documentation

Overview

Uses the Quandl v3 API to retrieve financial and economic datasets.

Usage

extern crate quandl;
extern crate chrono;

use quandl::QuandlRequest;
use chrono::NaiveDate;

fn main() {
  // basic request
  let _ = QuandlRequest::new("WIKI", "AAPL")
    .rows(5)
    .run();

  // specify some dates
  // Note: setting the start and end dates could fail (parsing error or inconsistency)
  // so when set, a Result is returned
  let _ = QuandlRequest::new("WIKI", "AAPL")
    .start_date("2015-11-10")
    .unwrap()
    .end_date("2015-11-12")
    .unwrap()
    .run();

  // pass a NaiveDate instead of a &str
  let d = NaiveDate::from_ymd(2015, 11, 20);
  let _ = QuandlRequest::new("WIKI", "AAPL")
    .start_date(&d)
    .unwrap()
    .run();
}

Testing

Some notes about the different testing options:

  • cargo test will run all tests that don't call the Quandl API.
  • cargo test --features skeptic will run tests on README.md. This will make calls to the Quandl API.
  • cargo test --features test-quandl-api will include tests that call the Quandl API.
  • cargo test --features "skeptic test-quandl-api" will run all tests.

clippy is also run as part of the nightly build on travis.

License

This library is distributed under similar terms to Rust: dual licensed under the MIT license and the Apache license (version 2.0).

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

Commit count: 31

cargo fmt