Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.36 KB

contributing.rst

File metadata and controls

48 lines (34 loc) · 1.36 KB

Contributing

Submitting a bug report

In case you experience issues using pyxs, do not hesitate to report it to the Bug Tracker on GitHub.

Setting up development environment

Writing a XenStore client library without having access to a running XenStore instance can be troublesome. Luckily, there is a way to setup a development using VirtualBox.

  1. Create a VM running Ubuntu 14.04 or later.
  2. Install Xen hypervisor: sudo apt-get install xen-hypervisor-4.4-amd64.
  3. Configure VM for SSH access.
  4. Done! You can now rsync your changes to the VM and run the tests.

Running the tests

Only root is allowed to access XenStore, so the tests require sudo:

$ sudo python setup.py test

pyxs strives to work across a range of Python versions. Use tox to run the tests on all supported versions:

$ cat tox.ini
[tox]
envlist = py26,py27,py34,py35,pypy

[testenv]
commands = python setup.py test
$ sudo tox

Style guide

pyxs follows Pocoo style guide. Please read it before you start implementing your changes.