openstack/os-win
Code Issues Proposed changes
57f9ef084f
os-win/README.rst
Flavio Percoco 8e9350aa5e 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/48ecbc2c3428cdf57d029888b2489731

Change-Id: I75c395b51a3bba6bdb92d4d7050713cb5ccce1bd
2016-11-25 17:13:51 +01:00

2.0 KiB
Raw Blame History

Team and repository tags

image

os-win

Windows / Hyper-V library for OpenStack projects.

This library contains Windows / Hyper-V specific code commonly used in OpenStack projects. The library can be used in any other OpenStack projects where it is needed.

How to Install

os-win is released on Pypi, meaning that it can be installed and upgraded via pip. To install os-win, run the following command:

pip install os-win

To upgrade os-win, run the following command:

pip install -U os-win

Note that the first OpenStack release to use os-win is Mitaka. Previous releases do not benefit from this library.

Tests

You will have to install the test dependencies first to be able to run the tests.

C:\os_win> pip install -r requirements.txt
C:\os_win> pip install -r test-requirements.txt

You can run the unit tests with the following command.

C:\os_win> nosetests os_win\tests\unit

How to contribute

To contribute to this project, please go through the following steps.

  1. Clone the project and keep your working tree updated.
  2. Make modifications on your working tree.
  3. Run unit tests.
  4. If the tests pass, commit your code.
  5. Submit your code via git review.
  6. Check that Jenkins and the Microsoft Hyper-V CI pass on your patch.
  7. If there are issues with your commit, ammend, and submit it again via git review.
  8. Wait for the patch to be reviewed.

Features

os-win is currently used in the following OpenStack projects:

  • nova
  • cinder
  • compute-hyperv
  • networking-hyperv
  • ceilometer
  • os-brick