| 1 | QEMU Python Tooling |
| 2 | =================== |
| 3 | |
| 4 | This package provides QEMU tooling used by the QEMU project to build, |
| 5 | configure, and test QEMU. It is not a fully-fledged SDK and it is subject |
| 6 | to change at any time. |
| 7 | |
| 8 | Usage |
| 9 | ----- |
| 10 | |
| 11 | The ``qemu.qmp`` subpackage provides a library for communicating with |
| 12 | QMP servers. The ``qemu.machine`` subpackage offers rudimentary |
| 13 | facilities for launching and managing QEMU processes. Refer to each |
| 14 | package's documentation |
| 15 | (``>>> help(qemu.qmp)``, ``>>> help(qemu.machine)``) |
| 16 | for more information. |
| 17 | |
| 18 | Contributing |
| 19 | ------------ |
| 20 | |
| 21 | This package is maintained by John Snow <jsnow@redhat.com> as part of |
| 22 | the QEMU source tree. Contributions are welcome and follow the `QEMU |
| 23 | patch submission process |
| 24 | <https://wiki.qemu.org/Contribute/SubmitAPatch>`_, which involves |
| 25 | sending patches to the QEMU development mailing list. |
| 26 | |
| 27 | John maintains a `GitLab staging branch |
| 28 | <https://gitlab.com/jsnow/qemu/-/tree/python>`_, and there is an |
| 29 | official `GitLab mirror <https://gitlab.com/qemu-project/qemu>`_. |
| 30 | |
| 31 | Please report bugs on the `QEMU issue tracker |
| 32 | <https://gitlab.com/qemu-project/qemu/-/issues>`_ and tag ``@jsnow`` in |
| 33 | the report. |
| 34 | |
| 35 | Optional packages necessary for running code quality analysis for this |
| 36 | package can be installed with the optional dependency group "devel": |
| 37 | ``pip install qemu[devel]``. |
| 38 | |
| 39 | ``make develop`` can be used to install this package in editable mode |
| 40 | (to the current environment) *and* bring in testing dependencies in one |
| 41 | command. |
| 42 | |
| 43 | ``make check`` can be used to run the available tests. |