| Message ID | 20210625154540.783306-5-jsnow@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Python: packaging cleanups | expand |
On Fri, Jun 25, 2021 at 12:46 PM John Snow <jsnow@redhat.com> wrote: > > Clarifying a few points; removing the reference to 'setuptools' because > it referenced anywhere else in this document and doesn't really provide > any useful information to a Python newcomer. > > Adjusting the language elsewhere to be less ambiguous and have fewer > run-on sentences. > > Signed-off-by: John Snow <jsnow@redhat.com> > --- > python/README.rst | 17 +++++++++-------- > 1 file changed, 9 insertions(+), 8 deletions(-) > Reviewed-by: Willian Rampazzo <willianr@redhat.com>
On 6/25/21 2:23 PM, Willian Rampazzo wrote: > On Fri, Jun 25, 2021 at 12:46 PM John Snow <jsnow@redhat.com> wrote: >> >> Clarifying a few points; removing the reference to 'setuptools' because >> it referenced anywhere else in this document and doesn't really provide ^ isn't Noticed the typo when adding your RB. >> any useful information to a Python newcomer. >> >> Adjusting the language elsewhere to be less ambiguous and have fewer >> run-on sentences. >> >> Signed-off-by: John Snow <jsnow@redhat.com> >> --- >> python/README.rst | 17 +++++++++-------- >> 1 file changed, 9 insertions(+), 8 deletions(-) >> > > Reviewed-by: Willian Rampazzo <willianr@redhat.com> > Thanks! I hope the new packaging has been (or will be?) helpful to avocado folks. --js
On 6/25/21 12:45 PM, John Snow wrote: > Clarifying a few points; removing the reference to 'setuptools' because > it referenced anywhere else in this document and doesn't really provide > any useful information to a Python newcomer. > > Adjusting the language elsewhere to be less ambiguous and have fewer > run-on sentences. > > Signed-off-by: John Snow <jsnow@redhat.com> > --- > python/README.rst | 17 +++++++++-------- > 1 file changed, 9 insertions(+), 8 deletions(-) Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com> > > diff --git a/python/README.rst b/python/README.rst > index dcf993819d..107786ffdc 100644 > --- a/python/README.rst > +++ b/python/README.rst > @@ -7,8 +7,7 @@ then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc). > > ``setup.py`` is used by ``pip`` to install this tooling to the current > environment. ``setup.cfg`` provides the packaging configuration used by > -``setup.py`` in a setuptools specific format. You will generally invoke > -it by doing one of the following: > +``setup.py``. 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 > @@ -17,12 +16,13 @@ it by doing one of the following: > > 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; you likely want the first invocation above. > + this will fail; you want the first invocation above. > > -If you append the ``-e`` argument, pip will install in "editable" mode; > -which installs a version of the package that installs a forwarder > -pointing to these files, such that the package always reflects the > -latest version in your git tree. > +If you append the ``--editable`` or ``-e`` argument to either invocation > +above, pip will install in "editable" mode. This installs the package as > +a forwarder ("qemu.egg-link") that points to the source tree. In so > +doing, the installed package always reflects the latest version in your > +source tree. > > Installing ".[devel]" instead of "." will additionally pull in required > packages for testing this package. They are not runtime requirements, > @@ -30,6 +30,7 @@ and are not needed to simply use these libraries. > > Running ``make develop`` will pull in all testing dependencies and > install QEMU in editable mode to the current environment. > +(It is a shortcut for ``pip3 install -e .[devel]``.) > > See `Installing packages using pip and virtual environments > <https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_ > @@ -39,7 +40,7 @@ for more information. > Files in this directory > ----------------------- > > -- ``qemu/`` Python package source directory. > +- ``qemu/`` Python 'qemu' namespace package source directory. > - ``tests/`` Python package tests directory. > - ``avocado.cfg`` Configuration for the Avocado test-runner. > Used by ``make check`` et al.
diff --git a/python/README.rst b/python/README.rst index dcf993819d..107786ffdc 100644 --- a/python/README.rst +++ b/python/README.rst @@ -7,8 +7,7 @@ then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc). ``setup.py`` is used by ``pip`` to install this tooling to the current environment. ``setup.cfg`` provides the packaging configuration used by -``setup.py`` in a setuptools specific format. You will generally invoke -it by doing one of the following: +``setup.py``. 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 @@ -17,12 +16,13 @@ it by doing one of the following: 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; you likely want the first invocation above. + this will fail; you want the first invocation above. -If you append the ``-e`` argument, pip will install in "editable" mode; -which installs a version of the package that installs a forwarder -pointing to these files, such that the package always reflects the -latest version in your git tree. +If you append the ``--editable`` or ``-e`` argument to either invocation +above, pip will install in "editable" mode. This installs the package as +a forwarder ("qemu.egg-link") that points to the source tree. In so +doing, the installed package always reflects the latest version in your +source tree. Installing ".[devel]" instead of "." will additionally pull in required packages for testing this package. They are not runtime requirements, @@ -30,6 +30,7 @@ and are not needed to simply use these libraries. Running ``make develop`` will pull in all testing dependencies and install QEMU in editable mode to the current environment. +(It is a shortcut for ``pip3 install -e .[devel]``.) See `Installing packages using pip and virtual environments <https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_ @@ -39,7 +40,7 @@ for more information. Files in this directory ----------------------- -- ``qemu/`` Python package source directory. +- ``qemu/`` Python 'qemu' namespace package source directory. - ``tests/`` Python package tests directory. - ``avocado.cfg`` Configuration for the Avocado test-runner. Used by ``make check`` et al.
Clarifying a few points; removing the reference to 'setuptools' because it referenced anywhere else in this document and doesn't really provide any useful information to a Python newcomer. Adjusting the language elsewhere to be less ambiguous and have fewer run-on sentences. Signed-off-by: John Snow <jsnow@redhat.com> --- python/README.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-)