os-win

======================== Team and repository tags

.. image:: https://governance.openstack.org/tc/badges/os-win.svg :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

====== 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.

• Free software: Apache license
• Documentation: http://docs.openstack.org/developer/os-win
• Source: https://opendev.org/openstack/os-win
• Bugs: https://bugs.launchpad.net/os-win

Release Notes

• https://docs.openstack.org/releasenotes/os-win

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.

• Clone the project and keep your working tree updated.
• Make modifications on your working tree.
• Run unit tests.
• If the tests pass, commit your code.
• Submit your code via git review.
• Check that Jenkins and the Microsoft Hyper-V CI pass on your patch.
• If there are issues with your commit, ammend, and submit it again via git review.
• 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