README.md

Dart API for the DERIVA platform.

This library offers a very minimal Dart API for the DERIVA platform.

Usage

A simple usage example:

import 'package:deriva/deriva.dart';

main() async {
  // properties that will be needed to establish a client connection
  String hostname = 'localhost';
  String catalog_id = '1';
  String token = '12345678909';
  
  // create credential and client
  var credential = format_credential(token: token);
  var client = ERMrestClient(hostname, catalog_id, credential: credential);
  
  // query the catalog using ERMrest paths
  try {
    var data = await client.query('/entity/dataset?limit=10');
    print(data);
  } catch (e) {
    print(e);
  } finally {
    // close the client connection, when finished
    client.close();
  }
}

Running the tests

To run the tests set the following environment variables:

$ export DERIVA_TEST_HOSTNAME=deriva.example.org
$ export DERIVA_TEST_CATALOG=1
$ export DERIVA_TEST_CREDENTIAL=123456789012345678901234

Then run the dart test command.

$  dart test                                             
00:03 +7: All tests passed!

Features and bugs

Please file feature requests and bugs at the issue tracker.