1ea1213b7SJohn SnowQEMU Python Tooling 2ea1213b7SJohn Snow=================== 3ea1213b7SJohn Snow 4ea1213b7SJohn SnowThis package provides QEMU tooling used by the QEMU project to build, 5ea1213b7SJohn Snowconfigure, and test QEMU. It is not a fully-fledged SDK and it is subject 6ea1213b7SJohn Snowto change at any time. 7ea1213b7SJohn Snow 8ea1213b7SJohn SnowUsage 9ea1213b7SJohn Snow----- 10ea1213b7SJohn Snow 11*37094b6dSJohn SnowThe ``qemu.qmp`` subpackage provides a library for communicating with 12ea1213b7SJohn SnowQMP servers. The ``qemu.machine`` subpackage offers rudimentary 13ea1213b7SJohn Snowfacilities for launching and managing QEMU processes. Refer to each 14ea1213b7SJohn Snowpackage's documentation 15*37094b6dSJohn Snow(``>>> help(qemu.qmp)``, ``>>> help(qemu.machine)``) 16ea1213b7SJohn Snowfor more information. 17ea1213b7SJohn Snow 18ea1213b7SJohn SnowContributing 19ea1213b7SJohn Snow------------ 20ea1213b7SJohn Snow 21ea1213b7SJohn SnowThis package is maintained by John Snow <jsnow@redhat.com> as part of 22ea1213b7SJohn Snowthe QEMU source tree. Contributions are welcome and follow the `QEMU 23ea1213b7SJohn Snowpatch submission process 24ea1213b7SJohn Snow<https://wiki.qemu.org/Contribute/SubmitAPatch>`_, which involves 25ea1213b7SJohn Snowsending patches to the QEMU development mailing list. 26ea1213b7SJohn Snow 27ea1213b7SJohn SnowJohn maintains a `GitLab staging branch 28ea1213b7SJohn Snow<https://gitlab.com/jsnow/qemu/-/tree/python>`_, and there is an 29ea1213b7SJohn Snowofficial `GitLab mirror <https://gitlab.com/qemu-project/qemu>`_. 30ea1213b7SJohn Snow 31ea1213b7SJohn SnowPlease report bugs on the `QEMU issue tracker 32ea1213b7SJohn Snow<https://gitlab.com/qemu-project/qemu/-/issues>`_ and tag ``@jsnow`` in 33ea1213b7SJohn Snowthe report. 34dbe75f55SJohn Snow 35dbe75f55SJohn SnowOptional packages necessary for running code quality analysis for this 36dbe75f55SJohn Snowpackage can be installed with the optional dependency group "devel": 37dbe75f55SJohn Snow``pip install qemu[devel]``. 386560379fSJohn Snow 396560379fSJohn Snow``make develop`` can be used to install this package in editable mode 406560379fSJohn Snow(to the current environment) *and* bring in testing dependencies in one 416560379fSJohn Snowcommand. 426560379fSJohn Snow 436560379fSJohn Snow``make check`` can be used to run the available tests. 44