mirror of
https://github.com/xemu-project/xemu.git
synced 2024-11-27 21:40:49 +00:00
6560379fac
Add "make venv" to create the pipenv-managed virtual environment that contains our explicitly pinned dependencies. Add "make check" to run the python linters [in the host execution environment]. Add "make venv-check" which combines the above two: create/update the venv, then run the linters in that explicitly managed environment. Add "make develop" which canonizes the runes needed to get both the linting pre-requisites (the "[devel]" part), and the editable live-install (the "-e" part) of these python libraries. make clean: delete miscellaneous python packaging output possibly created by pipenv, pip, or other python packaging utilities make distclean: delete the above, the .venv, and the editable "qemu" package forwarder (qemu.egg-info) if there is one. Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Cleber Rosa <crosa@redhat.com> Tested-by: Cleber Rosa <crosa@redhat.com> Message-id: 20210527211715.394144-29-jsnow@redhat.com Signed-off-by: John Snow <jsnow@redhat.com>
44 lines
1.5 KiB
ReStructuredText
44 lines
1.5 KiB
ReStructuredText
QEMU Python Tooling
|
|
===================
|
|
|
|
This package provides QEMU tooling used by the QEMU project to build,
|
|
configure, and test QEMU. It is not a fully-fledged SDK and it is subject
|
|
to change at any time.
|
|
|
|
Usage
|
|
-----
|
|
|
|
The ``qemu.qmp`` subpackage provides a library for communicating with
|
|
QMP servers. The ``qemu.machine`` subpackage offers rudimentary
|
|
facilities for launching and managing QEMU processes. Refer to each
|
|
package's documentation
|
|
(``>>> help(qemu.qmp)``, ``>>> help(qemu.machine)``)
|
|
for more information.
|
|
|
|
Contributing
|
|
------------
|
|
|
|
This package is maintained by John Snow <jsnow@redhat.com> as part of
|
|
the QEMU source tree. Contributions are welcome and follow the `QEMU
|
|
patch submission process
|
|
<https://wiki.qemu.org/Contribute/SubmitAPatch>`_, which involves
|
|
sending patches to the QEMU development mailing list.
|
|
|
|
John maintains a `GitLab staging branch
|
|
<https://gitlab.com/jsnow/qemu/-/tree/python>`_, and there is an
|
|
official `GitLab mirror <https://gitlab.com/qemu-project/qemu>`_.
|
|
|
|
Please report bugs on the `QEMU issue tracker
|
|
<https://gitlab.com/qemu-project/qemu/-/issues>`_ and tag ``@jsnow`` in
|
|
the report.
|
|
|
|
Optional packages necessary for running code quality analysis for this
|
|
package can be installed with the optional dependency group "devel":
|
|
``pip install qemu[devel]``.
|
|
|
|
``make develop`` can be used to install this package in editable mode
|
|
(to the current environment) *and* bring in testing dependencies in one
|
|
command.
|
|
|
|
``make check`` can be used to run the available tests.
|