| Message ID | 20201014142957.763624-5-jsnow@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | python: create installable package | expand |
On 10/14/20 4:29 PM, John Snow wrote: > Add short readmes to python/, python/qemu/, and python/qemu/core that > explain the directory hierarchy. These readmes are visible when browsing Maybe readmes -> READMEs Otherwise: Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> > the source on e.g. gitlab/github and are designed to help new > developers/users quickly make sense of the source tree. > > They are not designed for inclusion in a published manual. > > Signed-off-by: John Snow <jsnow@redhat.com> > --- > python/README.rst | 27 +++++++++++++++++++++++++++ > python/qemu/README.rst | 8 ++++++++ > python/qemu/core/README.rst | 9 +++++++++ > 3 files changed, 44 insertions(+) > create mode 100644 python/README.rst > create mode 100644 python/qemu/README.rst > create mode 100644 python/qemu/core/README.rst
On 10/14/20 2:05 PM, Philippe Mathieu-Daudé wrote: > On 10/14/20 4:29 PM, John Snow wrote: >> Add short readmes to python/, python/qemu/, and python/qemu/core that >> explain the directory hierarchy. These readmes are visible when browsing > > Maybe readmes -> READMEs > If you want it to match the filename, "README files". --js > Otherwise: > Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> > >> the source on e.g. gitlab/github and are designed to help new >> developers/users quickly make sense of the source tree. >> >> They are not designed for inclusion in a published manual. >> >> Signed-off-by: John Snow <jsnow@redhat.com> >> --- >> python/README.rst | 27 +++++++++++++++++++++++++++ >> python/qemu/README.rst | 8 ++++++++ >> python/qemu/core/README.rst | 9 +++++++++ >> 3 files changed, 44 insertions(+) >> create mode 100644 python/README.rst >> create mode 100644 python/qemu/README.rst >> create mode 100644 python/qemu/core/README.rst >
diff --git a/python/README.rst b/python/README.rst new file mode 100644 index 0000000000..fcc0552ec4 --- /dev/null +++ b/python/README.rst @@ -0,0 +1,27 @@ +QEMU Python Tooling +=================== + +This directory houses Python tooling used by the QEMU project to build, +configure, and test QEMU. It is organized by namespace (``qemu``), and +then by package (``qemu/core``). + +``setup.py`` is used by ``pip`` to install this tooling to the current +environment. You will generally invoke it by doing one of the following: + +1. ``pip3 install .`` will install these packages to your current + environment. If you are inside a virtual environment, they will + install there. If you are not, it will attempt to install to the + global environment, which is not recommended. + +2. ``pip3 install --user .`` will install these packages to your user's + local python packages. If you are inside of a virtual environment, + this will fail. + +If you amend the ``-e`` argument, pip will install in "editable" mode; +which installs a version of the package that uses symlinks to these +files, such that the package always reflects the latest version in your +git tree. + +See `Installing packages using pip and virtual environments +<https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_ +for more information. diff --git a/python/qemu/README.rst b/python/qemu/README.rst new file mode 100644 index 0000000000..31209c80a5 --- /dev/null +++ b/python/qemu/README.rst @@ -0,0 +1,8 @@ +QEMU Python Namespace +===================== + +This directory serves as the root of a `Python PEP 420 implicit +namespace package <<https://www.python.org/dev/peps/pep-0420/>`_. + +Each directory below is assumed to be an installable Python package that +is available under the ``qemu.<package>`` namespace. diff --git a/python/qemu/core/README.rst b/python/qemu/core/README.rst new file mode 100644 index 0000000000..91668e00bd --- /dev/null +++ b/python/qemu/core/README.rst @@ -0,0 +1,9 @@ +qemu.core Package +================= + +This package provides core utilities used for testing and debugging +QEMU. It is used by the iotests, vm tests, and several other utilities +in the ./scripts directory. It is not a fully-fledged SDK and it is +subject to change at any time. + +See the documentation in ``__init__.py`` for more information.
Add short readmes to python/, python/qemu/, and python/qemu/core that explain the directory hierarchy. These readmes are visible when browsing the source on e.g. gitlab/github and are designed to help new developers/users quickly make sense of the source tree. They are not designed for inclusion in a published manual. Signed-off-by: John Snow <jsnow@redhat.com> --- python/README.rst | 27 +++++++++++++++++++++++++++ python/qemu/README.rst | 8 ++++++++ python/qemu/core/README.rst | 9 +++++++++ 3 files changed, 44 insertions(+) create mode 100644 python/README.rst create mode 100644 python/qemu/README.rst create mode 100644 python/qemu/core/README.rst