openstack
/
js-openstack-lib
Code Issues Proposed changes
RETIRED, JavaScript API library for OpenStack.
108 Commits 1 Branch 2 Tags 1.5 MiB
Go to file
Flavio Percoco 02fb8b1d62 Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/f58218a48a92e39d9805b29538e63c50

Change-Id: Ie3313879c1242b12c1f6a017a40bf44045738838
 		2016-11-25 16:49:31 +01:00
doc Update OpenStack documentation template 2016-10-25 20:20:54 +02:00
src Added support for multi-region catalog 2016-10-25 12:44:20 +02:00
test Added support for multi-region catalog 2016-10-25 12:44:20 +02:00
.babelrc Use babel-plugin-transform-runtime instead of babel-polyfill 2016-09-05 19:25:18 +03:00
.editorconfig Initial commit of project. 2016-05-20 12:12:21 -07:00
.eslintignore Added jasmine-based testing harness. 2016-07-14 13:12:09 +03:00
.eslintrc Updates linting rules 2016-09-23 13:46:04 -04:00
.gitignore Ignore compiling output 2016-11-03 13:49:20 +08:00
.gitreview Update .gitreview 2016-05-20 12:23:44 -07:00
.istanbul.yml Created Version Class 2016-08-15 13:25:38 -07:00
.nsprc Added node-security-project checks 2016-06-23 12:53:07 +00:00
LICENSE Initial commit of project. 2016-05-20 12:12:21 -07:00
README.rst Show team and repo badges on README 2016-11-25 16:49:31 +01:00
Vagrantfile Added vagrant file for devstack bootstrap 2016-07-24 07:46:14 -07:00
bindep.txt Update OpenStack documentation template 2016-10-25 20:20:54 +02:00
configure-devstack.js Added Neutron Service 2016-09-26 14:05:34 -04:00
karma.conf.babel.js Add functional tests for devstack gate 2016-08-05 13:27:17 -04:00
karma.conf.js Added Karma integration 2016-07-19 12:19:35 -07:00
package.json Release 0.0.2 2016-10-19 19:52:10 -04:00
vagrant.sh Added networkList() method to neutron API 2016-10-05 15:58:42 -04:00
webpack.config.babel.js Add functional tests for devstack gate 2016-08-05 13:27:17 -04:00

README.rst

Team and repository tags

image

JS-OpenStack-lib

JS-OpenStack-lib is a Javascript library for interacting with OpenStack clouds. The project aims to provide a constistent and complete set of interactions with OpenStack's many services, along with documentations, examples, and tools. This library is compatible with both browser and server side Javascript.

Example

The following example simply connects to an OpenStack cloud and list flavors in the Compute service:

import OpenStack from 'js-openstack-lib';

// Initialize cloud
// cloudConfig is a JSON object corresponding to clouds.yaml
// (It is your responsibility to load and parse it)
const openStack = new OpenStack({
  region_name: 'Region1',
  auth: {
    username: 'user',
    password: 'pass',
    project_name: 'js-openstack-lib',
    auth_url: 'http://192.168.99.99/'
  }
});
// List all flavors
openStack.networkList()
  .then((networks) => {
    console.log(networks);
  });

Documentation

Coming soon

Contributing

If you're interested in contributing, the following will help you get started:

Bug Tracker

https://storyboard.openstack.org/#!/project/844

Code Hosting

https://git.openstack.org/cgit/openstack/js-openstack-lib

Code Review

https://review.openstack.org/#/q/status:open+project:openstack/js-openstack-lib,n,z

Please read Developer's Guide before sending your first patch for review

License

Apache 2.0