Ruby wrapper for Graphcommons API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc README update Jan 10, 2016
lib
.gitignore
LICENSE
README.md
graphcommons.gemspec version 0.0.5 Jan 10, 2016

README.md

graphcommons-ruby

version: 0.0.5 docs: rubydoc.info example: metagraph license: GPLv3

Ruby wrapper for Graphcommons API:

Graph Commons provides a simple REST API to programmatically make network maps (graphs) and integrate graphs into your applications. You can use our API to access Graph Commons API endpoints, which can get information on various graphs, nodes, and edges on the platform.

To get started, sign up to Graph Commons and get your developer key, which will be used for authentication in your API calls.

Installation

$ gem install graphcommons

Usage

First, add your key as an environment variable:

export GRAPHCOMMONS_API_KEY="XX_XXXXXXXXXXXXXXXXXXXXXX"

Then require the gem and you're good to go.

#irb

:001 > require 'graphcommons'
=> true 

:002 > Graphcommons::Endpoint.status
=> {"msg"=>"Working"} 

Alternatively, you can use the Graphcommons::API.set_key method. Please refer to the docs for more information.