qemu/python/README.rst

6 then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc).
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
22 above, pip will install in "editable" mode. This installs the package as
23 a forwarder ("qemu.egg-link") that points to the source tree. In so
24 doing, the installed package always reflects the latest version in your
28 packages for testing this package. They are not runtime requirements,
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 --------------------------------------------
48    https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
58 Package installation also normally provides executable console scripts,
59 so that tools like ``qmp-shell`` are always available via $PATH. To
62 ``> PYTHONPATH=~/src/qemu/python python3 -m qemu.qmp.qmp_shell``
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.