studio_napi

SUSE Studio API client library for Node.js

Author:	Roman Neuhauser
Contact:	[email protected]
Copyright:	This document is in the public domain.

Contents

• Overview
• Status
• Prerequisities
• Installation
• Hacking
  • Credentials for end-to-end tests
• Documentation

Overview

studio_napi is a client library for the SUSE Studio HTTP API targetting Node.js. Two interfaces are exposed, a low-level and a high-level one. Both interfaces implement both the admin and user sides of the API (v2 at the moment).

Status

studio_napi is in development. The low-level interface is implemented to a large extent, the last remaining bits are being fleshed out; the high-level interface has been designed and we started the implementation.

Prerequisities

• Node.js 0.6.x or higher
• NPM (any version appropriate for your version of Node.js)
• several packages installable with npm (see package.json)

Installation

studio_napi will appear in the NPM Registry once it's ready.

Hacking

If you want to hack on studio_napi:

git clone https://github.com/roman-neuhauser/studio_napi.git
cd studio_napi
make wc         # post-checkout setup
make check      # unit tests
make drive      # end-to-end tests
# happy hacking

The make wc above downloads and installs studio_napi's dependencies locally (in ./node_modules/).

Credentials for end-to-end tests

make drive needs to be supplied with a SUSE Studio server URL, as well as api username and key. It expects these to exist in files called cfg/admin and cfg/user. Templates for these files are in the cfg/ directory.

Documentation

See reference and examples.