1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
Contributing
============
Submitting a bug report
-----------------------
In case you experience issues using ``pyxs``, do not hesitate to report it
to the `Bug Tracker <https://github.com/hmmlearn/hmmlearn/issues>`_ 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 <http://www.skjegstad.com/blog/2015/01/19/mirageos-xen-virtualbox>`_
Xen hypervisor: ``sudo apt-get install xen-hypervisor-4.4-amd64``.
3. `Configure <http://stackoverflow.com/a/10532299/262432>`_ 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 <http://www.pocoo.org/internal/styleguide>`_ before you start
implementing your changes.
|
