qemu/python/README.rst

1 QEMU Python Tooling
4 This directory houses Python tooling used by the QEMU project to build,
5 configure, and test QEMU. It is organized by namespace (``qemu``), and
6 then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc).
8 ``setup.py`` is used by ``pip`` to install this tooling to the current
9 environment. ``setup.cfg`` provides the packaging configuration used by
10 ``setup.py``. You will generally invoke it by doing one of the following:
17 2. ``pip3 install --user .`` will install these packages to your user's
21 If you append the ``--editable`` or ``-e`` argument to either invocation
23 a forwarder ("qemu.egg-link") that points to the source tree. In so
32 install QEMU in editable mode to the current environment.
33 (It is a shortcut for ``pip3 install -e .[devel]``.)
36 <https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_
41 --------------------------------------------
47    directory, e.g. ``~/src/qemu/python``. See
48    https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
51    path prior to importing the ``qemu`` namespace. See
59 so that tools like ``qmp-shell`` are always available via $PATH. To
62 ``> PYTHONPATH=~/src/qemu/python python3 -m qemu.qmp.qmp_shell``
65 found in ``setup.cfg``.
69 -----------------------
71 - ``qemu/`` Python 'qemu' namespace package source directory.
72 - ``tests/`` Python package tests directory.
73 - ``avocado.cfg`` Configuration for the Avocado test-runner.
75 - ``Makefile`` provides some common testing/installation invocations.
77 - ``MANIFEST.in`` is read by python setuptools, it specifies additional files
79 - ``PACKAGE.rst`` is used as the README file that is visible on PyPI.org.
80 - ``README.rst`` you are here!
81 - ``VERSION`` contains the PEP-440 compliant version used to describe
82   this package; it is referenced by ``setup.cfg``.
83 - ``setup.cfg`` houses setuptools package configuration.
84 - ``setup.py`` is the setuptools installer used by pip; See above.