All of lore.kernel.org
 help / color / mirror / Atom feed
* [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo
@ 2022-03-30 18:24 John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 01/13] pylint hotfix John Snow
                   ` (12 more replies)
  0 siblings, 13 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

GitLab: https://gitlab.com/jsnow/qemu.qmp/-/commits/pt2a

Hi, this series is part of an effort to publish the qemu.qmp package on
PyPI. It is the second of three phases to complete this work:

    (1) Switch the new Async QMP library in to python/qemu/qmp
    (2) Fork python/qemu/qmp out into its own repository.
-->    (2a) Do the bare minimum to be consistent.
       (2b) Add most GitLab CI/CD targets.
       (2c) Add Sphinx doc builds, update docs, and publish to GitLab pages.
       (2d) Add dynamic git versioning and GitLab package builds.
    (3) Update qemu.git to install qemu.qmp from PyPI,
        and then delete python/qemu/qmp.

This series is not meant to apply to qemu.git, rather -- it's the series
that performs the split and would apply to a brand new repository.

I am submitting it to the QEMU mailing list because:

(1) To more broadly announce my intentions, and as reference alongside
series #1 and #3 detailed above. It'll be catalogued in the ML archives
this way, too.

(2) To ask for permission to become the maintainer of a
'qemu-project/py-qemu.qmp' repository, where I would like to host this
subproject.

(3) To ask for review on the README.rst file which details my intended
contribution guidelines for this subproject.

(4) To see if there's any feedback on the mechanics of how I forked this
subproject.

Review notes / points of interest:

- I use jsnow/qemu.qmp as the repo name throughout the series; that will
  have to be changed eventually, but for the purposes of prototyping, it
  was nicer to have a fully working series.

- I'm planning on using gitlab issues and MRs for the subproject.

- The intended versioning paradigm is recorded in patch #10.

- GitLab integration, automatic package builds, and other fancy features
  are saved for another series. It was getting extremely long, so let's
  stick to the basics, then add on each feature one at a time.

John Snow (13):
  pylint hotfix
  fork qemu.qmp from qemu.git
  update VERSION to 0.0.0a1
  update maintainer metadata
  update project description
  [FIXME] update project URLs
  add a couple new trove classifiers
  move README.rst to FILES.rst and update
  [FIXME] move PACKAGE.rst to README.rst and update
  docs: add versioning policy to README
  add LGPLv2+ and GPLv2 LICENSE files
  update Pipfile
  remove sub-dependency pins from Pipfile

 .gitignore            |   2 +-
 FILES.rst             |  67 ++++++
 LICENSE               | 481 ++++++++++++++++++++++++++++++++++++++++++
 LICENSE_GPL2          | 339 +++++++++++++++++++++++++++++
 MANIFEST.in           |   3 +-
 Makefile              |  16 +-
 PACKAGE.rst           |  43 ----
 Pipfile               |   4 +-
 Pipfile.lock          | 288 ++++++++++++++-----------
 README.rst            | 268 +++++++++++++++--------
 VERSION               |   2 +-
 qemu/qmp/__init__.py  |   2 +-
 qemu/qmp/legacy.py    |   4 +-
 qemu/qmp/qmp_shell.py |   2 +-
 qemu/qmp/qmp_tui.py   |   2 +-
 setup.cfg             |  43 ++--
 setup.py              |   2 +-
 17 files changed, 1260 insertions(+), 308 deletions(-)
 create mode 100644 FILES.rst
 create mode 100644 LICENSE
 create mode 100644 LICENSE_GPL2
 delete mode 100644 PACKAGE.rst

-- 
2.34.1




^ permalink raw reply	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 01/13] pylint hotfix
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git John Snow
                   ` (11 subsequent siblings)
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Pylint released a new version and it broke tests. I've folded this patch
into patches pending for qemu.git, but for my own sanity, I'm not going
to rebase this series yet because it's... annoying to rebase a
git-filter-branch fork. I'll get it next time, sorry.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qemu/qmp/legacy.py | 2 --
 1 file changed, 2 deletions(-)

diff --git a/qemu/qmp/legacy.py b/qemu/qmp/legacy.py
index a8629b4..03b5574 100644
--- a/qemu/qmp/legacy.py
+++ b/qemu/qmp/legacy.py
@@ -106,8 +106,6 @@ class QEMUMonitorProtocol:
         return self
 
     def __exit__(self,
-                 # pylint: disable=duplicate-code
-                 # see https://github.com/PyCQA/pylint/issues/3619
                  exc_type: Optional[Type[BaseException]],
                  exc_val: Optional[BaseException],
                  exc_tb: Optional[TracebackType]) -> None:
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 01/13] pylint hotfix John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-04-01 17:05   ` Kashyap Chamarthy
  2022-03-30 18:24 ` [qemu.qmp PATCH 03/13] update VERSION to 0.0.0a1 John Snow
                   ` (10 subsequent siblings)
  12 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Split python/ from qemu.git, using these commands:

> git subtree split -P python/ -b python-split-v3
> mkdir ~/src/tmp
> cd ~/src/tmp
> git clone --no-local --branch python-split-v3 --single-branch ~/src/qemu
> cd qemu
> git filter-repo --path qemu/machine/           \
                  --path qemu/utils/             \
                  --path tests/iotests-mypy.sh   \
                  --path tests/iotests-pylint.sh \
                  --invert-paths

This commit, however, only performs some minimum cleanup to reflect the
deletion of the other subpackages. It is not intended to be exhaustive,
and further edits are made in forthcoming commits.

These fixes are broken apart into micro-changes to facilitate mailing
list review subject-by-subject. They *could* be squashed into a single
larger commit on merge if desired, but due to the nature of the fork,
bisectability across the fork boundary is going to be challenging
anyway. It may be better value to just leave these initial commits
as-is.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 .gitignore |  2 +-
 Makefile   | 16 ++++++++--------
 setup.cfg  | 24 +-----------------------
 setup.py   |  2 +-
 4 files changed, 11 insertions(+), 33 deletions(-)

diff --git a/.gitignore b/.gitignore
index 904f324..b071f02 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,7 +5,7 @@
 # python packaging
 build/
 dist/
-qemu.egg-info/
+qemu.qmp.egg-info/
 
 # editor config
 .idea/
diff --git a/Makefile b/Makefile
index 3334311..a2d2f2c 100644
--- a/Makefile
+++ b/Makefile
@@ -30,7 +30,7 @@ help:
 	@echo ""
 	@echo "make develop:"
 	@echo "    Install deps needed for for 'make check',"
-	@echo "    and install the qemu package in editable mode."
+	@echo "    and install the qemu.qmp package in editable mode."
 	@echo "    (Can be used in or outside of a venv.)"
 	@echo ""
 	@echo "make pipenv"
@@ -43,7 +43,7 @@ help:
 	@echo "    Remove package build output."
 	@echo ""
 	@echo "make distclean:"
-	@echo "    remove pipenv/venv files, qemu package forwarder,"
+	@echo "    remove pipenv/venv files, qemu.qmp package forwarder,"
 	@echo "    built distribution files, and everything from 'make clean'."
 	@echo ""
 	@echo -e "Have a nice day ^_^\n"
@@ -64,11 +64,11 @@ dev-venv: $(QEMU_VENV_DIR) $(QEMU_VENV_DIR)/bin/activate
 $(QEMU_VENV_DIR) $(QEMU_VENV_DIR)/bin/activate: setup.cfg
 	@echo "VENV $(QEMU_VENV_DIR)"
 	@python3 -m venv $(QEMU_VENV_DIR)
-	@(							\
-		echo "ACTIVATE $(QEMU_VENV_DIR)";		\
-		. $(QEMU_VENV_DIR)/bin/activate;		\
-		echo "INSTALL qemu[devel] $(QEMU_VENV_DIR)";	\
-		make develop 1>/dev/null;			\
+	@(								\
+		echo "ACTIVATE $(QEMU_VENV_DIR)";			\
+		. $(QEMU_VENV_DIR)/bin/activate;			\
+		echo "INSTALL qemu.qmp[devel] $(QEMU_VENV_DIR)";	\
+		make develop 1>/dev/null;				\
 	)
 	@touch $(QEMU_VENV_DIR)
 
@@ -106,6 +106,6 @@ clean:
 
 .PHONY: distclean
 distclean: clean
-	rm -rf qemu.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
+	rm -rf qemu.qmp.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
 	rm -f .coverage .coverage.*
 	rm -rf htmlcov/
diff --git a/setup.cfg b/setup.cfg
index e877ea5..4ffab73 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,5 +1,5 @@
 [metadata]
-name = qemu
+name = qemu.qmp
 version = file:VERSION
 maintainer = QEMU Developer Team
 maintainer_email = qemu-devel@nongnu.org
@@ -25,8 +25,6 @@ classifiers =
 python_requires = >= 3.6
 packages =
     qemu.qmp
-    qemu.machine
-    qemu.utils
 
 [options.package_data]
 * = py.typed
@@ -38,7 +36,6 @@ packages =
 devel =
     avocado-framework >= 90.0
     flake8 >= 3.6.0
-    fusepy >= 2.0.4
     isort >= 5.1.2
     mypy >= 0.780
     pylint >= 2.8.0
@@ -47,10 +44,6 @@ devel =
     urwid-readline >= 0.13
     Pygments >= 2.9.0
 
-# Provides qom-fuse functionality
-fuse =
-    fusepy >= 2.0.4
-
 # QMP TUI dependencies
 tui =
     urwid >= 2.1.2
@@ -59,13 +52,6 @@ tui =
 
 [options.entry_points]
 console_scripts =
-    qom = qemu.utils.qom:main
-    qom-set = qemu.utils.qom:QOMSet.entry_point
-    qom-get = qemu.utils.qom:QOMGet.entry_point
-    qom-list = qemu.utils.qom:QOMList.entry_point
-    qom-tree = qemu.utils.qom:QOMTree.entry_point
-    qom-fuse = qemu.utils.qom_fuse:QOMFuse.entry_point [fuse]
-    qemu-ga-client = qemu.utils.qemu_ga_client:main
     qmp-shell = qemu.qmp.qmp_shell:main
     qmp-shell-wrap = qemu.qmp.qmp_shell:main_wrap
     qmp-tui = qemu.qmp.qmp_tui:main [tui]
@@ -80,19 +66,12 @@ python_version = 3.6
 warn_unused_configs = True
 namespace_packages = True
 
-[mypy-qemu.utils.qom_fuse]
-# fusepy has no type stubs:
-allow_subclassing_any = True
-
 [mypy-qemu.qmp.qmp_tui]
 # urwid and urwid_readline have no type stubs:
 allow_subclassing_any = True
 
 # The following missing import directives are because these libraries do not
 # provide type stubs. Allow them on an as-needed basis for mypy.
-[mypy-fuse]
-ignore_missing_imports = True
-
 [mypy-urwid]
 ignore_missing_imports = True
 
@@ -164,7 +143,6 @@ skip_missing_interpreters = true
 allowlist_externals = make
 deps =
     .[devel]
-    .[fuse]  # Workaround to trigger tox venv rebuild
     .[tui]   # Workaround to trigger tox venv rebuild
 commands =
     make check
diff --git a/setup.py b/setup.py
index c5bc459..aba951a 100755
--- a/setup.py
+++ b/setup.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 """
-QEMU tooling installer script
+QEMU QMP library installer script
 Copyright (c) 2020-2021 John Snow for Red Hat, Inc.
 """
 
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 03/13] update VERSION to 0.0.0a1
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 01/13] pylint hotfix John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 04/13] update maintainer metadata John Snow
                   ` (9 subsequent siblings)
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

qemu.qmp will be independently versioned, without regard to QEMU
version. While the repo is being established here, set the version to
something impossibly low.

Later, I intend to introduce automatic versioning based on git
tags. While the repo is being established it's going to be
easier to have a static version while we get bootstrapped.

(Note: PyPI already has a 0.0.0a0 version which I uploaded without prior
review to aid in developing and testing this series. This version, and
all alpha versions, will naturally be buried after the first real
non-alpha release.)

Signed-off-by: John Snow <jsnow@redhat.com>
---
 VERSION | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/VERSION b/VERSION
index c19f3b8..7741e1a 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.6.1.0a1
+0.0.0a1
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 04/13] update maintainer metadata
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (2 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 03/13] update VERSION to 0.0.0a1 John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 05/13] update project description John Snow
                   ` (8 subsequent siblings)
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Modify "QEMU Developer Team" to "QEMU Project", as this matches the
spelling we use for the collective on gitlab.com/qemu-project.

Add myself as the principal maintainer contact.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 setup.cfg | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/setup.cfg b/setup.cfg
index 4ffab73..f06f944 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,8 +1,10 @@
 [metadata]
 name = qemu.qmp
 version = file:VERSION
-maintainer = QEMU Developer Team
-maintainer_email = qemu-devel@nongnu.org
+author = QEMU Project
+author_email = qemu-devel@nongnu.org
+maintainer = John Snow
+maintainer_email = jsnow@redhat.com
 url = https://www.qemu.org/
 download_url = https://www.qemu.org/download/
 description = QEMU Python Build, Debug and SDK tooling.
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 05/13] update project description
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (3 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 04/13] update maintainer metadata John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-04-01 16:52   ` Beraldo Leal
  2022-03-30 18:24 ` [qemu.qmp PATCH 06/13] [FIXME] update project URLs John Snow
                   ` (7 subsequent siblings)
  12 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Signed-off-by: John Snow <jsnow@redhat.com>
---
 setup.cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.cfg b/setup.cfg
index f06f944..c21f2ce 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -7,7 +7,7 @@ maintainer = John Snow
 maintainer_email = jsnow@redhat.com
 url = https://www.qemu.org/
 download_url = https://www.qemu.org/download/
-description = QEMU Python Build, Debug and SDK tooling.
+description = QEMU Monitor Protocol library
 long_description = file:PACKAGE.rst
 long_description_content_type = text/x-rst
 classifiers =
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 06/13] [FIXME] update project URLs
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (4 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 05/13] update project description John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 07/13] add a couple new trove classifiers John Snow
                   ` (6 subsequent siblings)
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Point to this library's URLs instead of the entire project's.

FIXME: In development, the URLs here reference jsnow/qemu.qmp. It is
intended that the production version gets pushed to
qemu-project/python-qemu.qmp and will use URLs that reflect that
repository appropriately. This is being done so that I can easily
iterate and test on this patch series and make sure everything works
exactly as expected.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 setup.cfg | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/setup.cfg b/setup.cfg
index c21f2ce..776f4f1 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -5,8 +5,10 @@ author = QEMU Project
 author_email = qemu-devel@nongnu.org
 maintainer = John Snow
 maintainer_email = jsnow@redhat.com
-url = https://www.qemu.org/
-download_url = https://www.qemu.org/download/
+# NOTE: Remember to update the commit message when changing these URLs.
+url = https://gitlab.com/jsnow/qemu.qmp
+# NOTE: Remember to update the commit message when changing these URLs.
+download_url = https://gitlab.com/jsnow/qemu.qmp/-/packages
 description = QEMU Monitor Protocol library
 long_description = file:PACKAGE.rst
 long_description_content_type = text/x-rst
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 07/13] add a couple new trove classifiers
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (5 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 06/13] [FIXME] update project URLs John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-04-01 16:54   ` Beraldo Leal
  2022-03-30 18:24 ` [qemu.qmp PATCH 08/13] move README.rst to FILES.rst and update John Snow
                   ` (5 subsequent siblings)
  12 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Signed-off-by: John Snow <jsnow@redhat.com>
---
 setup.cfg | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/setup.cfg b/setup.cfg
index 776f4f1..44f913d 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -14,6 +14,7 @@ long_description = file:PACKAGE.rst
 long_description_content_type = text/x-rst
 classifiers =
     Development Status :: 3 - Alpha
+    Intended Audience :: Developers
     License :: OSI Approved :: GNU General Public License v2 (GPLv2)
     Natural Language :: English
     Operating System :: OS Independent
@@ -23,6 +24,7 @@ classifiers =
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
+    Topic :: System :: Emulators
     Typing :: Typed
 
 [options]
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 08/13] move README.rst to FILES.rst and update
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (6 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 07/13] add a couple new trove classifiers John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst " John Snow
                   ` (4 subsequent siblings)
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

The intent is to use README.rst as the new package-level readme that
will be bundled with the source and be displayed on the GitLab landing
page; so move the old "git level readme" over to FILES.rst instead, and
update it accordingly.

This is primarily here to just document and explain what all the little
bits and pieces of files in the root are and what they do. I find this
stuff helpful when I wander over into other projects, so I'd like to
extend the same courtesy.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 README.rst => FILES.rst | 49 +++++++++++------------------------------
 MANIFEST.in             |  1 -
 2 files changed, 13 insertions(+), 37 deletions(-)
 rename README.rst => FILES.rst (64%)

diff --git a/README.rst b/FILES.rst
similarity index 64%
rename from README.rst
rename to FILES.rst
index 9c1fcea..68892c3 100644
--- a/README.rst
+++ b/FILES.rst
@@ -1,9 +1,14 @@
-QEMU Python Tooling
+qemu.qmp File Index
 ===================
 
-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 (e.g. ``qemu/machine``, ``qemu/qmp``, etc).
+This file is here to explain the purpose of all the little bits and
+pieces of project files in the root directory and how they are
+used. It's useful info for those contributing to this project, but not
+so much for those who just want to use the library.
+
+
+Much ado about packaging
+------------------------
 
 ``setup.py`` is used by ``pip`` to install this tooling to the current
 environment. ``setup.cfg`` provides the packaging configuration used by
@@ -20,7 +25,7 @@ environment. ``setup.cfg`` provides the packaging configuration used by
 
 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
+a forwarder ("qemu.qmp.egg-link") that points to the source tree. In so
 doing, the installed package always reflects the latest version in your
 source tree.
 
@@ -37,34 +42,6 @@ See `Installing packages using pip and virtual environments
 for more information.
 
 
-Using these packages without installing them
---------------------------------------------
-
-These packages may be used without installing them first, by using one
-of two tricks:
-
-1. Set your PYTHONPATH environment variable to include this source
-   directory, e.g. ``~/src/qemu/python``. See
-   https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
-
-2. Inside a Python script, use ``sys.path`` to forcibly include a search
-   path prior to importing the ``qemu`` namespace. See
-   https://docs.python.org/3/library/sys.html#sys.path
-
-A strong downside to both approaches is that they generally interfere
-with static analysis tools being able to locate and analyze the code
-being imported.
-
-Package installation also normally provides executable console scripts,
-so that tools like ``qmp-shell`` are always available via $PATH. To
-invoke them without installation, you can invoke e.g.:
-
-``> PYTHONPATH=~/src/qemu/python python3 -m qemu.qmp.qmp_shell``
-
-The mappings between console script name and python module path can be
-found in ``setup.cfg``.
-
-
 Files in this directory
 -----------------------
 
@@ -72,6 +49,7 @@ Files in this directory
 - ``tests/`` Python package tests directory.
 - ``avocado.cfg`` Configuration for the Avocado test-runner.
   Used by ``make check`` et al.
+- ``FILES.rst`` you are here!
 - ``Makefile`` provides some common testing/installation invocations.
   Try ``make help`` to see available targets.
 - ``MANIFEST.in`` is read by python setuptools, it specifies additional files
@@ -80,8 +58,7 @@ Files in this directory
 - ``Pipfile`` is used by Pipenv to generate ``Pipfile.lock``.
 - ``Pipfile.lock`` is a set of pinned package dependencies that this package
   is tested under in our CI suite. It is used by ``make check-pipenv``.
-- ``README.rst`` you are here!
-- ``VERSION`` contains the PEP-440 compliant version used to describe
-  this package; it is referenced by ``setup.cfg``.
 - ``setup.cfg`` houses setuptools package configuration.
 - ``setup.py`` is the setuptools installer used by pip; See above.
+- ``VERSION`` contains the PEP-440 compliant version used to describe
+  this package; it is referenced by ``setup.cfg``.
diff --git a/MANIFEST.in b/MANIFEST.in
index 7059ad2..639caae 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,2 @@
 include VERSION
 include PACKAGE.rst
-exclude README.rst
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst and update
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (7 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 08/13] move README.rst to FILES.rst and update John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-04-01 16:40   ` Kashyap Chamarthy
  2022-03-30 18:24 ` [qemu.qmp PATCH 10/13] docs: add versioning policy to README John Snow
                   ` (3 subsequent siblings)
  12 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

The README here will reflect both what is shown on GitLab and on the
PyPI landing page. Update it accordingly, and freshen it up.

FIXME: Update URLs when pushing to the production repo.

Suggested-by: Kashyap Chamarthy <kchamart@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
 FILES.rst   |   2 +-
 MANIFEST.in |   2 +-
 PACKAGE.rst |  43 --------------
 README.rst  | 160 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.cfg   |   2 +-
 5 files changed, 163 insertions(+), 46 deletions(-)
 delete mode 100644 PACKAGE.rst
 create mode 100644 README.rst

diff --git a/FILES.rst b/FILES.rst
index 68892c3..0c29a88 100644
--- a/FILES.rst
+++ b/FILES.rst
@@ -54,10 +54,10 @@ Files in this directory
   Try ``make help`` to see available targets.
 - ``MANIFEST.in`` is read by python setuptools, it specifies additional files
   that should be included by a source distribution.
-- ``PACKAGE.rst`` is used as the README file that is visible on PyPI.org.
 - ``Pipfile`` is used by Pipenv to generate ``Pipfile.lock``.
 - ``Pipfile.lock`` is a set of pinned package dependencies that this package
   is tested under in our CI suite. It is used by ``make check-pipenv``.
+- ``README.rst`` is used as the README file that is visible on PyPI.org.
 - ``setup.cfg`` houses setuptools package configuration.
 - ``setup.py`` is the setuptools installer used by pip; See above.
 - ``VERSION`` contains the PEP-440 compliant version used to describe
diff --git a/MANIFEST.in b/MANIFEST.in
index 639caae..2a3fc58 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,2 @@
 include VERSION
-include PACKAGE.rst
+include README.rst
diff --git a/PACKAGE.rst b/PACKAGE.rst
deleted file mode 100644
index b0b86cc..0000000
--- a/PACKAGE.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-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.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..8593259
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,160 @@
+qemu.qmp: QEMU Monitor Protocol Library
+=======================================
+
+Welcome! ``qemu.qmp`` is a `QEMU Monitor Protocol
+<https://gitlab.com/qemu-project/qemu/-/blob/master/docs/interop/qmp-intro.txt>`_
+(“QMP”) library written in Python, using `asyncio
+<https://docs.python.org/3/library/asyncio.html>`_. It is used to send
+QMP messages to running `QEMU <https://www.qemu.org/>`_ emulators. It
+requires Python 3.6+ and has no mandatory dependencies.
+
+This library can be used to communicate with QEMU emulators, the `QEMU
+Guest Agent
+<https://qemu.readthedocs.io/en/latest/interop/qemu-ga.html>`_ (QGA),
+the `QEMU Storage Daemon
+<https://qemu.readthedocs.io/en/latest/tools/qemu-storage-daemon.html>`_
+(QSD), or any other utility or application that `speaks QMP
+<https://gitlab.com/qemu-project/qemu/-/blob/master/docs/interop/qmp-intro.txt>`_.
+
+This library makes as few assumptions as possible about the actual
+version or what type of endpoint it will be communicating with;
+i.e. this library does not contain command definitions and does not seek
+to be an SDK or a replacement for tools like `libvirt
+<https://libvirt.org/>`_ or `virsh
+<https://libvirt.org/manpages/virsh.html>`_. It is "simply" the protocol
+(QMP) and not the vocabulary (`QAPI
+<https://www.qemu.org/docs/master/devel/qapi-code-gen.html>`_). It is up
+to the library user (you!) to know which commands and arguments you want
+to send.
+
+
+Who is this library for?
+------------------------
+
+It is firstly for developers of QEMU themselves; as the test
+infrastructure of QEMU itself needs a convenient and scriptable
+interface for testing QEMU. This library was split out of the QEMU
+source tree in order to share a reference version of a QMP library that
+was usable both within and outside of the QEMU source tree.
+
+Second, it's for those who are developing *for* QEMU by adding new
+architectures, devices, or functionality; as well as targeting those who
+are developing *with* QEMU, i.e. developers working on integrating QEMU
+features into other projects such as libvirt, KubeVirt, Kata Containers,
+etc. Occasionally, using existing virtual-machine (VM) management stacks
+that integrate QEMU+KVM can make developing, testing, and debugging
+features difficult. In these cases, having more 'raw' access to QEMU is
+beneficial. This library is for you.
+
+Lastly, it's for power users who already use QEMU directly without the
+aid of libvirt because they require the raw control and power this
+affords them.
+
+
+Who isn't this library for?
+---------------------------
+
+It is not designed for anyone looking for a turn-key solution for VM
+management. QEMU is a low-level component that resembles a particularly
+impressive Swiss Army knife. This library does not manage that
+complexity and is largely "VM-ignorant". It's not a replacement for
+projects like `libvirt <https://libvirt.org/>`_, `virt-manager
+<https://virt-manager.org/>`_, `GNOME Boxes
+<https://wiki.gnome.org/Apps/Boxes>`_, etc.
+
+
+Installing
+----------
+
+This package can be installed from PyPI with pip: ``> pip3 install
+qemu.qmp``.
+
+
+Usage
+-----
+
+Launch QEMU with a monitor, e.g.::
+
+  > qemu-system-x86_64 -qmp unix:qmp.sock,server=on,wait=off
+
+
+Then, at its simplest, script-style usage looks like this::
+
+  import asyncio
+  from qemu.qmp import QMPClient
+
+  async def main():
+      qmp = QMPClient('my-vm-nickname')
+      await qmp.connect('qmp.sock')
+
+      res = await qmp.execute('query-status')
+      print(f"VM status: {res['status']}")
+
+      await qmp.disconnect()
+
+  asyncio.run(main())
+
+
+The above script will connect to the UNIX socket located at
+``qmp.sock``, query the VM's runstate, then print it out
+to the terminal::
+
+  > python3 example.py
+  VM status: running
+
+
+For more complex usages, especially those that make full advantage of
+monitoring asynchronous events, refer to the `online documentation
+<https://jsnow.gitlab.io/qemu.qmp/>`_ or type ``import qemu.qmp;
+help(qemu.qmp)`` in your Python terminal of choice.
+
+
+Contributing
+------------
+
+Contributions are quite welcome! Please file bugs using the `GitLab
+issue tracker <https://gitlab.com/jsnow/qemu.qmp/-/issues>`_. This
+project will accept GitLab merge requests, but due to the close
+association with the QEMU project, there are some additional guidelines:
+
+1. Please use the "Signed-off-by" tag in your commit messages. See
+   https://wiki.linuxfoundation.org/dco for more information on this
+   requirement.
+
+2. This repository won't squash merge requests into a single commit on
+   pull; each commit should seek to be self-contained (within reason).
+
+3. Owing to the above, each commit sent as part of a merge request
+   should not introduce any temporary regressions, even if fixed later
+   in the same merge request. This is done to preserve bisectability.
+
+4. Please associate every merge request with at least one `GitLab issue
+   <https://gitlab.com/jsnow/qemu.qmp/-/issues>`_. This helps with
+   generating Changelog text and staying organized. Thank you 🙇
+
+
+Developing
+^^^^^^^^^^
+
+Optional packages necessary for running code quality analysis for this
+package can be installed with the optional dependency group "devel":
+``pip install qemu.qmp[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. Consult ``make
+help`` for other targets and tests that make sense for different
+occasions.
+
+Before submitting a pull request, consider running ``make check-tox &&
+make check-pipenv`` locally to spot any issues that will cause the CI to
+fail. These checks use their own virtual environments and won't pollute
+your working space.
+
+
+Changelog
+---------
+
+- No public release yet.
diff --git a/setup.cfg b/setup.cfg
index 44f913d..a28cd0a 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -10,7 +10,7 @@ url = https://gitlab.com/jsnow/qemu.qmp
 # NOTE: Remember to update the commit message when changing these URLs.
 download_url = https://gitlab.com/jsnow/qemu.qmp/-/packages
 description = QEMU Monitor Protocol library
-long_description = file:PACKAGE.rst
+long_description = file:README.rst
 long_description_content_type = text/x-rst
 classifiers =
     Development Status :: 3 - Alpha
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 10/13] docs: add versioning policy to README
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (8 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst " John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-04-05  9:16   ` Damien Hedde
  2022-03-30 18:24 ` [qemu.qmp PATCH 11/13] add LGPLv2+ and GPLv2 LICENSE files John Snow
                   ` (2 subsequent siblings)
  12 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

The package is in an alpha state, but there's a method to the madness.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 README.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.rst b/README.rst
index 8593259..88efe84 100644
--- a/README.rst
+++ b/README.rst
@@ -154,6 +154,27 @@ fail. These checks use their own virtual environments and won't pollute
 your working space.
 
 
+Stability and Versioning
+------------------------
+
+This package uses a major.minor.micro SemVer versioning, with the
+following additional semantics during the alpha/beta period (Major
+version 0):
+
+This package treats 0.0.z versions as "alpha" versions. Each micro
+version update may change the API incompatibly. Early users are advised
+to pin against explicit versions, but check for updates often.
+
+A planned 0.1.z version will introduce the first "beta", whereafter each
+micro update will be backwards compatible, but each minor update will
+not be. The first beta version will be released after legacy.py is
+removed, and the API is tentatively "stable".
+
+Thereafter, normal SemVer/PEP440 rules will apply; micro updates will
+always be bugfixes, and minor updates will be reserved for backwards
+compatible feature changes.
+
+
 Changelog
 ---------
 
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 11/13] add LGPLv2+ and GPLv2 LICENSE files
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (9 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 10/13] docs: add versioning policy to README John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 12/13] update Pipfile John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 13/13] remove sub-dependency pins from Pipfile John Snow
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

This clarifies that the majority of this package is LGPLv2+. Copyright
blurbs that pointed to QEMU's "COPYING" file are amended to point to
this repository's "LICENSE" file instead.

The only file that is not already licensed as LGPLv2+ is legacy.py,
which is GPLv2 only. Amend the copyright blurb here to point to
LICENSE_GPL2, which is a copy of qemu.git's COPYING file.

legacy.py is scheduled for removal, at which point the license of this
library will become exclusively LGPLv2+. As the package currently
contains a mixture of LGPLv2+ and GPLv2 code, the trove classifiers will
reflect this mixture until such time as the remaining GPLv2 code is
removed.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 FILES.rst             |   3 +
 LICENSE               | 481 ++++++++++++++++++++++++++++++++++++++++++
 LICENSE_GPL2          | 339 +++++++++++++++++++++++++++++
 qemu/qmp/__init__.py  |   2 +-
 qemu/qmp/legacy.py    |   2 +-
 qemu/qmp/qmp_shell.py |   2 +-
 qemu/qmp/qmp_tui.py   |   2 +-
 setup.cfg             |   1 +
 8 files changed, 828 insertions(+), 4 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 LICENSE_GPL2

diff --git a/FILES.rst b/FILES.rst
index 0c29a88..f70e8de 100644
--- a/FILES.rst
+++ b/FILES.rst
@@ -50,6 +50,9 @@ Files in this directory
 - ``avocado.cfg`` Configuration for the Avocado test-runner.
   Used by ``make check`` et al.
 - ``FILES.rst`` you are here!
+- ``LICENSE`` This project is licensed as LGPLv2+; except for
+  ``legacy.py``.
+- ``LICENSE_GPL2`` This is the license for ``legacy.py``.
 - ``Makefile`` provides some common testing/installation invocations.
   Try ``make help`` to see available targets.
 - ``MANIFEST.in`` is read by python setuptools, it specifies additional files
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..12735e6
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,481 @@
+                  GNU LIBRARY GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the library GPL.  It is
+ numbered 2 because it goes with version 2 of the ordinary GPL.]
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Library General Public License, applies to some
+specially designated Free Software Foundation software, and to any
+other libraries whose authors decide to use it.  You can use it for
+your libraries, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if
+you distribute copies of the library, or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link a program with the library, you must provide
+complete object files to the recipients so that they can relink them
+with the library, after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  Our method of protecting your rights has two steps: (1) copyright
+the library, and (2) offer you this license which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  Also, for each distributor's protection, we want to make certain
+that everyone understands that there is no warranty for this free
+library.  If the library is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original
+version, so that any problems introduced by others will not reflect on
+the original authors' reputations.
+\f
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that companies distributing free
+software will individually obtain patent licenses, thus in effect
+transforming the program into proprietary software.  To prevent this,
+we have made it clear that any patent must be licensed for everyone's
+free use or not licensed at all.
+
+  Most GNU software, including some libraries, is covered by the ordinary
+GNU General Public License, which was designed for utility programs.  This
+license, the GNU Library General Public License, applies to certain
+designated libraries.  This license is quite different from the ordinary
+one; be sure to read it in full, and don't assume that anything in it is
+the same as in the ordinary license.
+
+  The reason we have a separate public license for some libraries is that
+they blur the distinction we usually make between modifying or adding to a
+program and simply using it.  Linking a program with a library, without
+changing the library, is in some sense simply using the library, and is
+analogous to running a utility program or application program.  However, in
+a textual and legal sense, the linked executable is a combined work, a
+derivative of the original library, and the ordinary General Public License
+treats it as such.
+
+  Because of this blurred distinction, using the ordinary General
+Public License for libraries did not effectively promote software
+sharing, because most developers did not use the libraries.  We
+concluded that weaker conditions might promote sharing better.
+
+  However, unrestricted linking of non-free programs would deprive the
+users of those programs of all benefit from the free status of the
+libraries themselves.  This Library General Public License is intended to
+permit developers of non-free programs to use free libraries, while
+preserving your freedom as a user of such programs to change the free
+libraries that are incorporated in them.  (We have not seen how to achieve
+this as regards changes in header files, but we have achieved it as regards
+changes in the actual functions of the Library.)  The hope is that this
+will lead to faster development of free libraries.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, while the latter only
+works together with the library.
+
+  Note that it is possible for a library to be covered by the ordinary
+General Public License rather than by this special one.
+\f
+                  GNU LIBRARY GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library which
+contains a notice placed by the copyright holder or other authorized
+party saying it may be distributed under the terms of this Library
+General Public License (also called "this License").  Each licensee is
+addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+\f
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+\f
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+\f
+  6. As an exception to the Sections above, you may also compile or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    c) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    d) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the source code distributed need not include anything that is normally
+distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+\f
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+\f
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Library General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+\f
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+                            NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+\f
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!
diff --git a/LICENSE_GPL2 b/LICENSE_GPL2
new file mode 100644
index 0000000..00ccfbb
--- /dev/null
+++ b/LICENSE_GPL2
@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+\f
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/qemu/qmp/__init__.py b/qemu/qmp/__init__.py
index 69190d0..569df07 100644
--- a/qemu/qmp/__init__.py
+++ b/qemu/qmp/__init__.py
@@ -19,7 +19,7 @@ managing QMP events.
 # Based on earlier work by Luiz Capitulino <lcapitulino@redhat.com>.
 #
 # This work is licensed under the terms of the GNU LGPL, version 2 or
-# later. See the COPYING file in the top-level directory.
+# later. See the LICENSE file in the top-level directory.
 
 import logging
 
diff --git a/qemu/qmp/legacy.py b/qemu/qmp/legacy.py
index 03b5574..8065366 100644
--- a/qemu/qmp/legacy.py
+++ b/qemu/qmp/legacy.py
@@ -18,7 +18,7 @@ old interface.
 #  John Snow <jsnow@redhat.com>
 #
 # This work is licensed under the terms of the GNU GPL, version 2.  See
-# the COPYING file in the top-level directory.
+# the LICENSE_GPL2 file in the top-level directory.
 #
 
 import asyncio
diff --git a/qemu/qmp/qmp_shell.py b/qemu/qmp/qmp_shell.py
index 619ab42..7122237 100644
--- a/qemu/qmp/qmp_shell.py
+++ b/qemu/qmp/qmp_shell.py
@@ -6,7 +6,7 @@
 #  John Snow <jsnow@redhat.com>
 #
 # This work is licensed under the terms of the GNU LGPL, version 2 or
-# later. See the COPYING file in the top-level directory.
+# later. See the LICENSE file in the top-level directory.
 #
 
 """
diff --git a/qemu/qmp/qmp_tui.py b/qemu/qmp/qmp_tui.py
index ce239d8..a60d832 100644
--- a/qemu/qmp/qmp_tui.py
+++ b/qemu/qmp/qmp_tui.py
@@ -4,7 +4,7 @@
 #  Niteesh Babu G S <niteesh.gs@gmail.com>
 #
 # This work is licensed under the terms of the GNU LGPL, version 2 or
-# later.  See the COPYING file in the top-level directory.
+# later.  See the LICENSE file in the top-level directory.
 """
 QMP TUI
 
diff --git a/setup.cfg b/setup.cfg
index a28cd0a..3947873 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -15,6 +15,7 @@ long_description_content_type = text/x-rst
 classifiers =
     Development Status :: 3 - Alpha
     Intended Audience :: Developers
+    License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
     License :: OSI Approved :: GNU General Public License v2 (GPLv2)
     Natural Language :: English
     Operating System :: OS Independent
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 12/13] update Pipfile
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (10 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 11/13] add LGPLv2+ and GPLv2 LICENSE files John Snow
@ 2022-03-30 18:24 ` John Snow
  2022-03-30 18:24 ` [qemu.qmp PATCH 13/13] remove sub-dependency pins from Pipfile John Snow
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

The name of the package has changed and the dependencies are different,
so the Pipfile needs to be updated.

This is a little annoying, but Python doesn't offer any tool (to my
knowledge) that behaves in a manner that gives you the *oldest*, but
still adequate, versions of dependencies. So testing minimum version
requirements is actually kind of challenging.

So, do it manually: pin every version at the minimum that still allows
the tests to succeed. This is the best way to experimentally determine
what precisely our development minimum criteria actually are.

Most of these follow from just observing the minimum stated requirements
for each package, manually, recursively. However, I observed that toml's
stated dependency of >= 0.9.4 in pylint actually needs to be >= 0.10.0.

(If you're new to pipenv, it's a tool separate from packaging metadata
that is used to provide a precise specification for a virtual
environment. In this repository, I am using it to pin a testing
environment against the very oldest packages we support in order to test
that we do not break compatibility with older versions of python,
pylint, mypy, etc.)

Signed-off-by: John Snow <jsnow@redhat.com>
---
 Pipfile      |  37 ++++++-
 Pipfile.lock | 288 ++++++++++++++++++++++++++++-----------------------
 2 files changed, 195 insertions(+), 130 deletions(-)

diff --git a/Pipfile b/Pipfile
index e7acb8c..595b83f 100644
--- a/Pipfile
+++ b/Pipfile
@@ -4,10 +4,43 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-qemu = {editable = true, extras = ["devel"], path = "."}
+avocado-framework = "==90.0"
+isort = "==5.1.2"
+tox = "==3.18.0"
+toml = "==0.10.0"
+six = "==1.14.0"
+filelock = "==3.0.0"
+virtualenv = "==16.0.0"
+py = "==1.4.17"
+pluggy = "==0.12.0"
+pyparsing = "==2.0.2"
+"backports.entry-points-selectable" = "==1.0.4"
+platformdirs = "==2.0.0"
+distlib = "==0.3.1"
+importlib-metadata = "==0.12"
+zipp = "==0.5"
+pylint = "==2.8.0"
+astroid = "==2.5.4"
+mccabe = "==0.6"
+lazy-object-proxy = "==1.4.0"
+wrapt = "==1.11"
+flake8 = "==3.6.0"
+pycodestyle = "==2.4.0"
+pyflakes = "==2.0.0"
+mypy = "==0.780"
+typed-ast = "==1.4.0"
+typing-extensions = "==3.7.4"
+mypy-extensions = "==0.4.3"
+urwid = "==2.1.2"
+urwid-readline = "==0.13"
+Pygments = "==2.9.0"
+"qemu.qmp" = {editable = true, extras = ["devel"], path = "."}
 
 [packages]
-qemu = {editable = true,path = "."}
+urwid = "==2.1.2"
+urwid-readline = "==0.13"
+Pygments = "==2.9.0"
+"qemu.qmp" = {editable = true, extras = ["tui"], path = "."}
 
 [requires]
 python_version = "3.6"
diff --git a/Pipfile.lock b/Pipfile.lock
index ce46404..f771fb6 100644
--- a/Pipfile.lock
+++ b/Pipfile.lock
@@ -1,7 +1,7 @@
 {
     "_meta": {
         "hash": {
-            "sha256": "f1a25654d884a5b450e38d78b1f2e3ebb9073e421cc4358d4bbb83ac251a5670"
+            "sha256": "b9067d0e558c07da0a02abceee8495da37c3eb7246d555e7061709521cdf3777"
         },
         "pipfile-spec": 6,
         "requires": {
@@ -16,26 +16,51 @@
         ]
     },
     "default": {
-        "qemu": {
+        "pygments": {
+            "hashes": [
+                "sha256:a18f47b506a429f6f4b9df81bb02beab9ca21d0a5fee38ed15aef65f0545519f",
+                "sha256:d66e804411278594d764fc69ec36ec13d9ae9147193a1740cd34d272ca383b8e"
+            ],
+            "index": "pypi",
+            "version": "==2.9.0"
+        },
+        "qemu-qmp": {
             "editable": true,
+            "extras": [
+                "tui"
+            ],
             "path": "."
+        },
+        "qemu.qmp": {
+            "editable": true,
+            "extras": [
+                "tui"
+            ],
+            "path": "."
+        },
+        "urwid": {
+            "hashes": [
+                "sha256:588bee9c1cb208d0906a9f73c613d2bd32c3ed3702012f51efe318a3f2127eae"
+            ],
+            "index": "pypi",
+            "version": "==2.1.2"
+        },
+        "urwid-readline": {
+            "hashes": [
+                "sha256:018020cbc864bb5ed87be17dc26b069eae2755cb29f3a9c569aac3bded1efaf4"
+            ],
+            "index": "pypi",
+            "version": "==0.13"
         }
     },
     "develop": {
-        "appdirs": {
-            "hashes": [
-                "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41",
-                "sha256:a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128"
-            ],
-            "version": "==1.4.4"
-        },
         "astroid": {
             "hashes": [
-                "sha256:09bdb456e02564731f8b5957cdd0c98a7f01d2db5e90eb1d794c353c28bfd705",
-                "sha256:6a8a51f64dae307f6e0c9db752b66a7951e282389d8362cc1d39a56f3feeb31d"
+                "sha256:f040fe9c4a2a7699a8ec30c9ed10fb59067c97f64c36577f476c0953ba29847c",
+                "sha256:f9f472d4002d55199b1c151ef0570cf71d42aaa34aaa3d29c3e41c75f6f47564"
             ],
             "index": "pypi",
-            "version": "==2.6.0"
+            "version": "==2.5.4"
         },
         "avocado-framework": {
             "hashes": [
@@ -45,21 +70,28 @@
             "index": "pypi",
             "version": "==90.0"
         },
+        "backports.entry-points-selectable": {
+            "hashes": [
+                "sha256:2a238e1d8b212b9cf50156b63cd748d54dc33df74e590d614507fc9ce57d0d4a",
+                "sha256:4acda84d96855beece3bf9aad9a1030aceb5f744b8ce9af7d5ee6dd672cdd3bd"
+            ],
+            "index": "pypi",
+            "version": "==1.0.4"
+        },
         "distlib": {
             "hashes": [
-                "sha256:106fef6dc37dd8c0e2c0a60d3fca3e77460a48907f335fa28420463a6f799736",
-                "sha256:23e223426b28491b1ced97dc3bbe183027419dfc7982b4fa2f05d5f3ff10711c"
+                "sha256:8c09de2c67b3e7deef7184574fc060ab8a793e7adbb183d942c389c8b13c52fb",
+                "sha256:edf6116872c863e1aa9d5bb7cb5e05a022c519a4594dc703843343a9ddd9bff1"
             ],
             "index": "pypi",
-            "version": "==0.3.2"
+            "version": "==0.3.1"
         },
         "filelock": {
             "hashes": [
-                "sha256:18d82244ee114f543149c66a6e0c14e9c4f8a1044b5cdaadd0f82159d6a6ff59",
-                "sha256:929b7d63ec5b7d6b71b0fa5ac14e030b3f70b75747cef1b10da9b879fef15836"
+                "sha256:b3ad481724adfb2280773edd95ce501e497e88fa4489c6e41e637ab3fd9a456c"
             ],
             "index": "pypi",
-            "version": "==3.0.12"
+            "version": "==3.0.0"
         },
         "flake8": {
             "hashes": [
@@ -69,29 +101,13 @@
             "index": "pypi",
             "version": "==3.6.0"
         },
-        "fusepy": {
-            "hashes": [
-                "sha256:10f5c7f5414241bffecdc333c4d3a725f1d6605cae6b4eaf86a838ff49cdaf6c",
-                "sha256:a9f3a3699080ddcf0919fd1eb2cf743e1f5859ca54c2018632f939bdfac269ee"
-            ],
-            "index": "pypi",
-            "version": "==2.0.4"
-        },
         "importlib-metadata": {
             "hashes": [
-                "sha256:90bb658cdbbf6d1735b6341ce708fc7024a3e14e99ffdc5783edea9f9b077f83",
-                "sha256:dc15b2969b4ce36305c51eebe62d418ac7791e9a157911d58bfb1f9ccd8e2070"
-            ],
-            "markers": "python_version < '3.8'",
-            "version": "==1.7.0"
-        },
-        "importlib-resources": {
-            "hashes": [
-                "sha256:54161657e8ffc76596c4ede7080ca68cb02962a2e074a2586b695a93a925d36e",
-                "sha256:e962bff7440364183203d179d7ae9ad90cb1f2b74dcb84300e88ecc42dca3351"
+                "sha256:2f2e54cbf6b06b16351e4c40a6adb0860cab6cfb95a0c0fcb58bb789c4b450f5",
+                "sha256:37bbea81dec44d1ff72d58a1b5c1599a9f3436537f33e9e26f276610064c4830"
             ],
             "index": "pypi",
-            "version": "==5.1.4"
+            "version": "==0.12"
         },
         "isort": {
             "hashes": [
@@ -103,38 +119,35 @@
         },
         "lazy-object-proxy": {
             "hashes": [
-                "sha256:17e0967ba374fc24141738c69736da90e94419338fd4c7c7bef01ee26b339653",
-                "sha256:1fee665d2638491f4d6e55bd483e15ef21f6c8c2095f235fef72601021e64f61",
-                "sha256:22ddd618cefe54305df49e4c069fa65715be4ad0e78e8d252a33debf00f6ede2",
-                "sha256:24a5045889cc2729033b3e604d496c2b6f588c754f7a62027ad4437a7ecc4837",
-                "sha256:410283732af311b51b837894fa2f24f2c0039aa7f220135192b38fcc42bd43d3",
-                "sha256:4732c765372bd78a2d6b2150a6e99d00a78ec963375f236979c0626b97ed8e43",
-                "sha256:489000d368377571c6f982fba6497f2aa13c6d1facc40660963da62f5c379726",
-                "sha256:4f60460e9f1eb632584c9685bccea152f4ac2130e299784dbaf9fae9f49891b3",
-                "sha256:5743a5ab42ae40caa8421b320ebf3a998f89c85cdc8376d6b2e00bd12bd1b587",
-                "sha256:85fb7608121fd5621cc4377a8961d0b32ccf84a7285b4f1d21988b2eae2868e8",
-                "sha256:9698110e36e2df951c7c36b6729e96429c9c32b3331989ef19976592c5f3c77a",
-                "sha256:9d397bf41caad3f489e10774667310d73cb9c4258e9aed94b9ec734b34b495fd",
-                "sha256:b579f8acbf2bdd9ea200b1d5dea36abd93cabf56cf626ab9c744a432e15c815f",
-                "sha256:b865b01a2e7f96db0c5d12cfea590f98d8c5ba64ad222300d93ce6ff9138bcad",
-                "sha256:bf34e368e8dd976423396555078def5cfc3039ebc6fc06d1ae2c5a65eebbcde4",
-                "sha256:c6938967f8528b3668622a9ed3b31d145fab161a32f5891ea7b84f6b790be05b",
-                "sha256:d1c2676e3d840852a2de7c7d5d76407c772927addff8d742b9808fe0afccebdf",
-                "sha256:d7124f52f3bd259f510651450e18e0fd081ed82f3c08541dffc7b94b883aa981",
-                "sha256:d900d949b707778696fdf01036f58c9876a0d8bfe116e8d220cfd4b15f14e741",
-                "sha256:ebfd274dcd5133e0afae738e6d9da4323c3eb021b3e13052d8cbd0e457b1256e",
-                "sha256:ed361bb83436f117f9917d282a456f9e5009ea12fd6de8742d1a4752c3017e93",
-                "sha256:f5144c75445ae3ca2057faac03fda5a902eff196702b0a24daf1d6ce0650514b"
+                "sha256:118d53f8819f9457732dd0e418752f2850f395c5405b2e12485f52336e4ad0f5",
+                "sha256:495c583b363c3eded649e2c00177093f03f856f5c9f95b527420084a9ce17b9d",
+                "sha256:55fa9eab93482891ce97473e63610efdd9c8fa5c05cca9f60468c412e602e499",
+                "sha256:642fc0a9b61920669dab66e400f79f1b8b0e8f698dcde85f7e9ae5528dbcaf4a",
+                "sha256:7003959a170fde9b92936c38562810f94679c80608fb4b007e026b915bef8b27",
+                "sha256:7e63da94f5a1ddb0d2dcdb5d17ff4d1d33f51f3368bdf0475d5f56c0f3b99592",
+                "sha256:7fb11d33d99a374e4b0c3fb20128890b9cf784ca7e4b91ecbb191d34618bd9fe",
+                "sha256:8758715ea005afa293783797498d64f40ab14d1ded208b3e282760cde9512f1d",
+                "sha256:8995543f47a8b81962e384f12791114af9f4997be7a0db71abc40d2a2dfee961",
+                "sha256:91c7e1316116fedda36818ce7cd269378fffc4219781536eff441ea1e68e1caf",
+                "sha256:9b41ec246d31ca6a840dcf67673b2668adc5a095c64310d26d73292588563ea3",
+                "sha256:a8be3cfd7c3154e8d39276c627c5e7ee55d1f2094597b060ece99620ef9fe86b",
+                "sha256:afcab74f471652b643900e0862b31892ac5fe5a75e435b786a1825855f4effdf",
+                "sha256:d49a90c27074f44c8dc147d83e31140523948ee147b3248634c540e053caea58",
+                "sha256:d6957cadc9c079ef4697564af500d52fba6d14fb2f08d20ce92f52201fb77050",
+                "sha256:da7f2a6c82a11dc4e05bab73522f0d6dd4f3bbc8378cd4b0769137f342cdb3f0",
+                "sha256:f03a21f6f6e54778860122a620f70c8b148ec4ee175968782bcaaa94955a46f9",
+                "sha256:f6c718ffca055852479880debbe717da952fcfd60067a0ddb6fe3b053b1d4de0"
             ],
             "index": "pypi",
-            "version": "==1.6.0"
+            "version": "==1.4.0"
         },
         "mccabe": {
             "hashes": [
-                "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42",
-                "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"
+                "sha256:c6f88ac33667c89d6588e5189334d051f186f4dd3ae5139586af54677c36b5a8",
+                "sha256:de9bbfe5b771e4c11b1521f3e338fe265a12296b59302f43a3bbf3e02d4b98b1"
             ],
-            "version": "==0.6.1"
+            "index": "pypi",
+            "version": "==0.6"
         },
         "mypy": {
             "hashes": [
@@ -161,31 +174,39 @@
                 "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d",
                 "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8"
             ],
+            "index": "pypi",
             "version": "==0.4.3"
         },
         "packaging": {
             "hashes": [
-                "sha256:5b327ac1320dc863dca72f4514ecc086f31186744b84a230374cc1fd776feae5",
-                "sha256:67714da7f7bc052e064859c05c595155bd1ee9f69f76557e21f051443c20947a"
+                "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb",
+                "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"
+            ],
+            "markers": "python_version >= '3.6'",
+            "version": "==21.3"
+        },
+        "platformdirs": {
+            "hashes": [
+                "sha256:9fc2bc9a5f04bfd5b12c1edb64394f6108c17b2a5be0a461f9a8b08c8a7d8991",
+                "sha256:c4d969c6d051f37548994641338c74f3125b771e8fbbe4a45d60d4a976e34533"
             ],
             "index": "pypi",
-            "version": "==20.9"
+            "version": "==2.0.0"
         },
         "pluggy": {
             "hashes": [
-                "sha256:15b2acde666561e1298d71b523007ed7364de07029219b604cf808bfa1c765b0",
-                "sha256:966c145cd83c96502c3c3868f50408687b38434af77734af1e9ca461a4081d2d"
+                "sha256:0825a152ac059776623854c1543d65a4ad408eb3d33ee114dff91e57ec6ae6fc",
+                "sha256:b9817417e95936bf75d85d3f8767f7df6cdde751fc40aed3bb3074cbcb77757c"
             ],
             "index": "pypi",
-            "version": "==0.13.1"
+            "version": "==0.12.0"
         },
         "py": {
             "hashes": [
-                "sha256:21b81bda15b66ef5e1a777a21c4dcd9c20ad3efd0b3f817e7a809035269e1bd3",
-                "sha256:3b80836aa6d1feeaa108e046da6423ab8f6ceda6468545ae8d02d9d58d18818a"
+                "sha256:45d74855a614c73f97b0cbbe5615e5be34fa623ecf5ee6b7a4417f9a52665fb7"
             ],
             "index": "pypi",
-            "version": "==1.10.0"
+            "version": "==1.4.17"
         },
         "pycodestyle": {
             "hashes": [
@@ -193,6 +214,7 @@
                 "sha256:cbc619d09254895b0d12c2c691e237b2e91e9b2ecf5e84c26b35400f93dcfb83",
                 "sha256:cbfca99bd594a10f674d0cd97a3d802a1fdef635d4361e1a2658de47ed261e3a"
             ],
+            "index": "pypi",
             "version": "==2.4.0"
         },
         "pyflakes": {
@@ -200,6 +222,7 @@
                 "sha256:9a7662ec724d0120012f6e29d6248ae3727d821bba522a0e6b356eff19126a49",
                 "sha256:f661252913bc1dbe7fcfcbf0af0db3f42ab65aabd1a6ca68fe5d466bace94dae"
             ],
+            "index": "pypi",
             "version": "==2.0.0"
         },
         "pygments": {
@@ -220,14 +243,31 @@
         },
         "pyparsing": {
             "hashes": [
-                "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1",
-                "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"
+                "sha256:1039385c4702ba1834f1d5d6a832c3acdb499c7a8ffdd460ba6d381df3c30cda",
+                "sha256:1584a093537c6f0add04a514b91b55fda93e2331de7e5140f835d7d8662ea291",
+                "sha256:17e43d6b17588ed5968735575b3983a952133ec4082596d214d7090b56d48a06",
+                "sha256:3a203a88fc0f0b3c21909de3367ade6b51b2f32abb4e6932bcbf197273593f72",
+                "sha256:4dda9208817b3a1fe7d500408e4d5ebbb8e4549ba377e6a259ab2552e1275b0b",
+                "sha256:7145b41ff85f2428e365f2b9bd16b69bd68f1150c3f8d05528273505ede15abe",
+                "sha256:8e395e5c5c7d95e62b4a6a5311afbf8644b6d5f8280e033aebfca38d1f637486",
+                "sha256:a4c2134b09d85dc250422cdd1ab1c4bc4603dd5016f881c2a987c472778a9a14",
+                "sha256:d61cce2ef4bc4eb27d99bc5130e30be1bfbe59fe41e804255f06061cbec0388f"
             ],
             "index": "pypi",
-            "version": "==2.4.7"
+            "version": "==2.0.2"
         },
-        "qemu": {
+        "qemu-qmp": {
             "editable": true,
+            "extras": [
+                "tui"
+            ],
+            "path": "."
+        },
+        "qemu.qmp": {
+            "editable": true,
+            "extras": [
+                "tui"
+            ],
             "path": "."
         },
         "setuptools": {
@@ -240,19 +280,20 @@
         },
         "six": {
             "hashes": [
-                "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926",
-                "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"
+                "sha256:236bdbdce46e6e6a3d61a337c0f8b763ca1e8717c03b369e87a7ec7ce1319c0a",
+                "sha256:8f3cd2e254d8f793e7f3d6d9df77b92252b52637291d0f0da013c76ea2724b6c"
             ],
-            "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
-            "version": "==1.16.0"
+            "index": "pypi",
+            "version": "==1.14.0"
         },
         "toml": {
             "hashes": [
-                "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b",
-                "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"
+                "sha256:229f81c57791a41d65e399fc06bf0848bab550a9dfd5ed66df18ce5f05e73d5c",
+                "sha256:235682dd292d5899d361a811df37e04a8828a5b1da3115886b73cf81ebc9100e",
+                "sha256:f1db651f9657708513243e61e6cc67d101a39bad662eaa9b5546f789338e07a3"
             ],
-            "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'",
-            "version": "==0.10.2"
+            "index": "pypi",
+            "version": "==0.10.0"
         },
         "tox": {
             "hashes": [
@@ -264,48 +305,38 @@
         },
         "typed-ast": {
             "hashes": [
-                "sha256:01ae5f73431d21eead5015997ab41afa53aa1fbe252f9da060be5dad2c730ace",
-                "sha256:067a74454df670dcaa4e59349a2e5c81e567d8d65458d480a5b3dfecec08c5ff",
-                "sha256:0fb71b8c643187d7492c1f8352f2c15b4c4af3f6338f21681d3681b3dc31a266",
-                "sha256:1b3ead4a96c9101bef08f9f7d1217c096f31667617b58de957f690c92378b528",
-                "sha256:2068531575a125b87a41802130fa7e29f26c09a2833fea68d9a40cf33902eba6",
-                "sha256:209596a4ec71d990d71d5e0d312ac935d86930e6eecff6ccc7007fe54d703808",
-                "sha256:2c726c276d09fc5c414693a2de063f521052d9ea7c240ce553316f70656c84d4",
-                "sha256:398e44cd480f4d2b7ee8d98385ca104e35c81525dd98c519acff1b79bdaac363",
-                "sha256:52b1eb8c83f178ab787f3a4283f68258525f8d70f778a2f6dd54d3b5e5fb4341",
-                "sha256:5feca99c17af94057417d744607b82dd0a664fd5e4ca98061480fd8b14b18d04",
-                "sha256:7538e495704e2ccda9b234b82423a4038f324f3a10c43bc088a1636180f11a41",
-                "sha256:760ad187b1041a154f0e4d0f6aae3e40fdb51d6de16e5c99aedadd9246450e9e",
-                "sha256:777a26c84bea6cd934422ac2e3b78863a37017618b6e5c08f92ef69853e765d3",
-                "sha256:95431a26309a21874005845c21118c83991c63ea800dd44843e42a916aec5899",
-                "sha256:9ad2c92ec681e02baf81fdfa056fe0d818645efa9af1f1cd5fd6f1bd2bdfd805",
-                "sha256:9c6d1a54552b5330bc657b7ef0eae25d00ba7ffe85d9ea8ae6540d2197a3788c",
-                "sha256:aee0c1256be6c07bd3e1263ff920c325b59849dc95392a05f258bb9b259cf39c",
-                "sha256:af3d4a73793725138d6b334d9d247ce7e5f084d96284ed23f22ee626a7b88e39",
-                "sha256:b36b4f3920103a25e1d5d024d155c504080959582b928e91cb608a65c3a49e1a",
-                "sha256:b9574c6f03f685070d859e75c7f9eeca02d6933273b5e69572e5ff9d5e3931c3",
-                "sha256:bff6ad71c81b3bba8fa35f0f1921fb24ff4476235a6e94a26ada2e54370e6da7",
-                "sha256:c190f0899e9f9f8b6b7863debfb739abcb21a5c054f911ca3596d12b8a4c4c7f",
-                "sha256:c907f561b1e83e93fad565bac5ba9c22d96a54e7ea0267c708bffe863cbe4075",
-                "sha256:cae53c389825d3b46fb37538441f75d6aecc4174f615d048321b716df2757fb0",
-                "sha256:dd4a21253f42b8d2b48410cb31fe501d32f8b9fbeb1f55063ad102fe9c425e40",
-                "sha256:dde816ca9dac1d9c01dd504ea5967821606f02e510438120091b84e852367428",
-                "sha256:f2362f3cb0f3172c42938946dbc5b7843c2a28aec307c49100c8b38764eb6927",
-                "sha256:f328adcfebed9f11301eaedfa48e15bdece9b519fb27e6a8c01aa52a17ec31b3",
-                "sha256:f8afcf15cc511ada719a88e013cec87c11aff7b91f019295eb4530f96fe5ef2f",
-                "sha256:fb1bbeac803adea29cedd70781399c99138358c26d05fcbd23c13016b7f5ec65"
+                "sha256:1170afa46a3799e18b4c977777ce137bb53c7485379d9706af8a59f2ea1aa161",
+                "sha256:18511a0b3e7922276346bcb47e2ef9f38fb90fd31cb9223eed42c85d1312344e",
+                "sha256:262c247a82d005e43b5b7f69aff746370538e176131c32dda9cb0f324d27141e",
+                "sha256:2b907eb046d049bcd9892e3076c7a6456c93a25bebfe554e931620c90e6a25b0",
+                "sha256:354c16e5babd09f5cb0ee000d54cfa38401d8b8891eefa878ac772f827181a3c",
+                "sha256:48e5b1e71f25cfdef98b013263a88d7145879fbb2d5185f2a0c79fa7ebbeae47",
+                "sha256:4e0b70c6fc4d010f8107726af5fd37921b666f5b31d9331f0bd24ad9a088e631",
+                "sha256:630968c5cdee51a11c05a30453f8cd65e0cc1d2ad0d9192819df9978984529f4",
+                "sha256:66480f95b8167c9c5c5c87f32cf437d585937970f3fc24386f313a4c97b44e34",
+                "sha256:71211d26ffd12d63a83e079ff258ac9d56a1376a25bc80b1cdcdf601b855b90b",
+                "sha256:7954560051331d003b4e2b3eb822d9dd2e376fa4f6d98fee32f452f52dd6ebb2",
+                "sha256:838997f4310012cf2e1ad3803bce2f3402e9ffb71ded61b5ee22617b3a7f6b6e",
+                "sha256:95bd11af7eafc16e829af2d3df510cecfd4387f6453355188342c3e79a2ec87a",
+                "sha256:bc6c7d3fa1325a0c6613512a093bc2a2a15aeec350451cbdf9e1d4bffe3e3233",
+                "sha256:cc34a6f5b426748a507dd5d1de4c1978f2eb5626d51326e43280941206c209e1",
+                "sha256:d755f03c1e4a51e9b24d899561fec4ccaf51f210d52abdf8c07ee2849b212a36",
+                "sha256:d7c45933b1bdfaf9f36c579671fec15d25b06c8398f113dab64c18ed1adda01d",
+                "sha256:d896919306dd0aa22d0132f62a1b78d11aaf4c9fc5b3410d3c666b818191630a",
+                "sha256:fdc1c9bbf79510b76408840e009ed65958feba92a88833cdceecff93ae8fff66",
+                "sha256:ffde2fbfad571af120fcbfbbc61c72469e72f550d676c3342492a9dfdefb8f12"
             ],
-            "markers": "python_version < '3.8' and implementation_name == 'cpython'",
-            "version": "==1.4.3"
+            "index": "pypi",
+            "version": "==1.4.0"
         },
         "typing-extensions": {
             "hashes": [
-                "sha256:0ac0f89795dd19de6b97debb0c6af1c70987fd80a2d62d1958f7e56fcc31b497",
-                "sha256:50b6f157849174217d0656f99dc82fe932884fb250826c18350e159ec6cdf342",
-                "sha256:779383f6086d90c99ae41cf0ff39aac8a7937a9283ce0a414e5dd782f4c94a84"
+                "sha256:2ed632b30bb54fc3941c382decfd0ee4148f5c591651c9272473fea2c6397d95",
+                "sha256:b1edbbf0652660e32ae780ac9433f4231e7339c7f9a8057d0f042fcbcea49b87",
+                "sha256:d8179012ec2c620d3791ca6fe2bf7979d979acdbef1fca0bc56b37411db682ed"
             ],
             "index": "pypi",
-            "version": "==3.10.0.0"
+            "version": "==3.7.4"
         },
         "urwid": {
             "hashes": [
@@ -323,25 +354,26 @@
         },
         "virtualenv": {
             "hashes": [
-                "sha256:14fdf849f80dbb29a4eb6caa9875d476ee2a5cf76a5f5415fa2f1606010ab467",
-                "sha256:2b0126166ea7c9c3661f5b8e06773d28f83322de7a3ff7d06f0aed18c9de6a76"
+                "sha256:2ce32cd126117ce2c539f0134eb89de91a8413a29baac49cbab3eb50e2026669",
+                "sha256:ca07b4c0b54e14a91af9f34d0919790b016923d157afda5efdde55c96718f752"
             ],
             "index": "pypi",
-            "version": "==20.4.7"
+            "version": "==16.0.0"
         },
         "wrapt": {
             "hashes": [
-                "sha256:b62ffa81fb85f4332a4f609cab4ac40709470da05643a082ec1eb88e6d9b97d7"
+                "sha256:e03f19f64d81d0a3099518ca26b04550026f131eced2e76ced7b85c6b8d32128"
             ],
-            "version": "==1.12.1"
+            "index": "pypi",
+            "version": "==1.11"
         },
         "zipp": {
             "hashes": [
-                "sha256:3607921face881ba3e026887d8150cca609d517579abe052ac81fc5aeffdbd76",
-                "sha256:51cb66cc54621609dd593d1787f286ee42a5c0adbb4b29abea5a63edc3e03098"
+                "sha256:46dfd547d9ccbf8bdc26ecea52818046bb28509f12bb6a0de1cd66ab06e9a9be",
+                "sha256:d7ac25f895fb65bff937b381353c14eb1fa23d35f40abd72a5342cd57eb57fd1"
             ],
             "index": "pypi",
-            "version": "==3.4.1"
+            "version": "==0.5"
         }
     }
 }
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* [qemu.qmp PATCH 13/13] remove sub-dependency pins from Pipfile
  2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
                   ` (11 preceding siblings ...)
  2022-03-30 18:24 ` [qemu.qmp PATCH 12/13] update Pipfile John Snow
@ 2022-03-30 18:24 ` John Snow
  12 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-03-30 18:24 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy, John Snow,
	Markus Armbruster, Cleber Rosa, Eric Blake

Now that we've got a Pipfile.lock generated that works, we can remove
the static pins from the Pipfile to allow various dependencies to be
added or removed as necessary when updating our direct dependencies in
the future.

So long as --keep-outdated is always passed to Pipenv, items that aren't
absolutely necessary to update will not be, which will help keep our
requirements more at the very oldest possible versions that still work.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 Pipfile | 33 ---------------------------------
 1 file changed, 33 deletions(-)

diff --git a/Pipfile b/Pipfile
index 595b83f..f44fd1e 100644
--- a/Pipfile
+++ b/Pipfile
@@ -4,42 +4,9 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-avocado-framework = "==90.0"
-isort = "==5.1.2"
-tox = "==3.18.0"
-toml = "==0.10.0"
-six = "==1.14.0"
-filelock = "==3.0.0"
-virtualenv = "==16.0.0"
-py = "==1.4.17"
-pluggy = "==0.12.0"
-pyparsing = "==2.0.2"
-"backports.entry-points-selectable" = "==1.0.4"
-platformdirs = "==2.0.0"
-distlib = "==0.3.1"
-importlib-metadata = "==0.12"
-zipp = "==0.5"
-pylint = "==2.8.0"
-astroid = "==2.5.4"
-mccabe = "==0.6"
-lazy-object-proxy = "==1.4.0"
-wrapt = "==1.11"
-flake8 = "==3.6.0"
-pycodestyle = "==2.4.0"
-pyflakes = "==2.0.0"
-mypy = "==0.780"
-typed-ast = "==1.4.0"
-typing-extensions = "==3.7.4"
-mypy-extensions = "==0.4.3"
-urwid = "==2.1.2"
-urwid-readline = "==0.13"
-Pygments = "==2.9.0"
 "qemu.qmp" = {editable = true, extras = ["devel"], path = "."}
 
 [packages]
-urwid = "==2.1.2"
-urwid-readline = "==0.13"
-Pygments = "==2.9.0"
 "qemu.qmp" = {editable = true, extras = ["tui"], path = "."}
 
 [requires]
-- 
2.34.1



^ permalink raw reply related	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst and update
  2022-03-30 18:24 ` [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst " John Snow
@ 2022-04-01 16:40   ` Kashyap Chamarthy
  2022-04-01 17:31     ` John Snow
  0 siblings, 1 reply; 25+ messages in thread
From: Kashyap Chamarthy @ 2022-04-01 16:40 UTC (permalink / raw)
  To: John Snow
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

On Wed, Mar 30, 2022 at 02:24:20PM -0400, John Snow wrote:
> The README here will reflect both what is shown on GitLab and on the
> PyPI landing page. Update it accordingly, and freshen it up.
> 
> FIXME: Update URLs when pushing to the production repo.
> 
> Suggested-by: Kashyap Chamarthy <kchamart@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---

Hi,

This version reads good to me. :)

[...]

> +
> +Who isn't this library for?
> +---------------------------
> +
> +It is not designed for anyone looking for a turn-key solution for VM
> +management. QEMU is a low-level component that resembles a particularly
> +impressive Swiss Army knife. This library does not manage that
> +complexity and is largely "VM-ignorant". It's not a replacement for
> +projects like `libvirt <https://libvirt.org/>`_, `virt-manager
> +<https://virt-manager.org/>`_, `GNOME Boxes
> +<https://wiki.gnome.org/Apps/Boxes>`_, etc.
> +
> +
> +Installing
> +----------
> +
> +This package can be installed from PyPI with pip: ``> pip3 install
> +qemu.qmp``.
> 
> +
> +Usage
> +-----
> +
> +Launch QEMU with a monitor, e.g.::
> +
> +  > qemu-system-x86_64 -qmp unix:qmp.sock,server=on,wait=off
> +
> +
> +Then, at its simplest, script-style usage looks like this::
> +
> +  import asyncio
> +  from qemu.qmp import QMPClient
> +
> +  async def main():
> +      qmp = QMPClient('my-vm-nickname')
> +      await qmp.connect('qmp.sock')
> +
> +      res = await qmp.execute('query-status')
> +      print(f"VM status: {res['status']}")
> +
> +      await qmp.disconnect()
> +
> +  asyncio.run(main())

Tested the exmaple; this works!

> +The above script will connect to the UNIX socket located at
> +``qmp.sock``, query the VM's runstate, then print it out
> +to the terminal::
> +
> +  > python3 example.py
> +  VM status: running
> +
> +
> +For more complex usages, especially those that make full advantage of
> +monitoring asynchronous events, refer to the `online documentation
> +<https://jsnow.gitlab.io/qemu.qmp/>`_ or type ``import qemu.qmp;
> +help(qemu.qmp)`` in your Python terminal of choice.
> +
> +
> +Contributing
> +------------
> +
> +Contributions are quite welcome! Please file bugs using the `GitLab
> +issue tracker <https://gitlab.com/jsnow/qemu.qmp/-/issues>`_. This
> +project will accept GitLab merge requests, but due to the close
> +association with the QEMU project, there are some additional guidelines:
> +
> +1. Please use the "Signed-off-by" tag in your commit messages. See
> +   https://wiki.linuxfoundation.org/dco for more information on this
> +   requirement.
> +
> +2. This repository won't squash merge requests into a single commit on
> +   pull; each commit should seek to be self-contained (within reason).
> +
> +3. Owing to the above, each commit sent as part of a merge request
> +   should not introduce any temporary regressions, even if fixed later
> +   in the same merge request. This is done to preserve bisectability.
> +
> +4. Please associate every merge request with at least one `GitLab issue
> +   <https://gitlab.com/jsnow/qemu.qmp/-/issues>`_. This helps with
> +   generating Changelog text and staying organized. Thank you 🙇

/me didn't miss the Japanese bow.

> +Developing
> +^^^^^^^^^^
> +
> +Optional packages necessary for running code quality analysis for this
> +package can be installed with the optional dependency group "devel":
> +``pip install qemu.qmp[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. Consult ``make
> +help`` for other targets and tests that make sense for different
> +occasions.
> +
> +Before submitting a pull request, consider running ``make check-tox &&
> +make check-pipenv`` locally to spot any issues that will cause the CI to
> +fail. These checks use their own virtual environments and won't pollute
> +your working space.

Nit: Consider hyper-linking "virtual environments" to:
https://docs.python.org/3/library/venv.html#module-venv

(I realize, within context people will recognize the term "virtual
environment" is not a virtual guest environment, but a Python venv.  I
have a mild preference for being explicit here.)

FWIW:

Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> 

[...]
 

-- 
/kashyap



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 05/13] update project description
  2022-03-30 18:24 ` [qemu.qmp PATCH 05/13] update project description John Snow
@ 2022-04-01 16:52   ` Beraldo Leal
  0 siblings, 0 replies; 25+ messages in thread
From: Beraldo Leal @ 2022-04-01 16:52 UTC (permalink / raw)
  To: John Snow
  Cc: Daniel Berrange, Kashyap Chamarthy, qemu-devel,
	Markus Armbruster, Cleber Rosa, Eric Blake

On Wed, Mar 30, 2022 at 02:24:16PM -0400, John Snow wrote:
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  setup.cfg | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/setup.cfg b/setup.cfg
> index f06f944..c21f2ce 100644
> --- a/setup.cfg
> +++ b/setup.cfg
> @@ -7,7 +7,7 @@ maintainer = John Snow
>  maintainer_email = jsnow@redhat.com
>  url = https://www.qemu.org/
>  download_url = https://www.qemu.org/download/
> -description = QEMU Python Build, Debug and SDK tooling.
> +description = QEMU Monitor Protocol library
>  long_description = file:PACKAGE.rst
>  long_description_content_type = text/x-rst
>  classifiers =

Reviewed-by: Beraldo Leal <bleal@redhat.com>

--
Beraldo



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 07/13] add a couple new trove classifiers
  2022-03-30 18:24 ` [qemu.qmp PATCH 07/13] add a couple new trove classifiers John Snow
@ 2022-04-01 16:54   ` Beraldo Leal
  0 siblings, 0 replies; 25+ messages in thread
From: Beraldo Leal @ 2022-04-01 16:54 UTC (permalink / raw)
  To: John Snow
  Cc: Daniel Berrange, Kashyap Chamarthy, qemu-devel,
	Markus Armbruster, Cleber Rosa, Eric Blake

On Wed, Mar 30, 2022 at 02:24:18PM -0400, John Snow wrote:
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  setup.cfg | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/setup.cfg b/setup.cfg
> index 776f4f1..44f913d 100644
> --- a/setup.cfg
> +++ b/setup.cfg
> @@ -14,6 +14,7 @@ long_description = file:PACKAGE.rst
>  long_description_content_type = text/x-rst
>  classifiers =
>      Development Status :: 3 - Alpha
> +    Intended Audience :: Developers
>      License :: OSI Approved :: GNU General Public License v2 (GPLv2)
>      Natural Language :: English
>      Operating System :: OS Independent
> @@ -23,6 +24,7 @@ classifiers =
>      Programming Language :: Python :: 3.8
>      Programming Language :: Python :: 3.9
>      Programming Language :: Python :: 3.10
> +    Topic :: System :: Emulators
>      Typing :: Typed
>  
>  [options]
> -- 
> 2.34.1
> 

Reviewed-by: Beraldo Leal <bleal@redhat.com>

--
Beraldo



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git
  2022-03-30 18:24 ` [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git John Snow
@ 2022-04-01 17:05   ` Kashyap Chamarthy
  2022-04-04 18:54     ` John Snow
  0 siblings, 1 reply; 25+ messages in thread
From: Kashyap Chamarthy @ 2022-04-01 17:05 UTC (permalink / raw)
  To: John Snow
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

On Wed, Mar 30, 2022 at 02:24:13PM -0400, John Snow wrote:
> Split python/ from qemu.git, using these commands:
> 
> > git subtree split -P python/ -b python-split-v3
> > mkdir ~/src/tmp
> > cd ~/src/tmp
> > git clone --no-local --branch python-split-v3 --single-branch ~/src/qemu
> > cd qemu
> > git filter-repo --path qemu/machine/           \
>                   --path qemu/utils/             \
>                   --path tests/iotests-mypy.sh   \
>                   --path tests/iotests-pylint.sh \
>                   --invert-paths
> 
> This commit, however, only performs some minimum cleanup to reflect the
> deletion of the other subpackages. It is not intended to be exhaustive,
> and further edits are made in forthcoming commits.
> 
> These fixes are broken apart into micro-changes to facilitate mailing
> list review subject-by-subject. They *could* be squashed into a single
> larger commit on merge if desired, but due to the nature of the fork,
> bisectability across the fork boundary is going to be challenging
> anyway. It may be better value to just leave these initial commits
> as-is.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  .gitignore |  2 +-
>  Makefile   | 16 ++++++++--------
>  setup.cfg  | 24 +-----------------------
>  setup.py   |  2 +-
>  4 files changed, 11 insertions(+), 33 deletions(-)

The changes here look fine to me (and thanks for making it a "micro
change").  I'll let sharper eyes than mine to give a closer look at the
`git filter-repo` surgery.  Although, that looks fine to me too.

[...]

>  .PHONY: distclean
>  distclean: clean
> -	rm -rf qemu.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> +	rm -rf qemu.qmp.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
>  	rm -f .coverage .coverage.*
>  	rm -rf htmlcov/
> diff --git a/setup.cfg b/setup.cfg
> index e877ea5..4ffab73 100644
> --- a/setup.cfg
> +++ b/setup.cfg
> @@ -1,5 +1,5 @@
>  [metadata]
> -name = qemu
> +name = qemu.qmp
>  version = file:VERSION
>  maintainer = QEMU Developer Team

In the spirit of patch 04 ("update maintainer metadata"), do you also
want to update here too? s/QEMU Developer Team/QEMU Project?

FWIW:

Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>    

[...]

-- 
/kashyap



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst and update
  2022-04-01 16:40   ` Kashyap Chamarthy
@ 2022-04-01 17:31     ` John Snow
  0 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-04-01 17:31 UTC (permalink / raw)
  To: Kashyap Chamarthy
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

[-- Attachment #1: Type: text/plain, Size: 5319 bytes --]

On Fri, Apr 1, 2022, 12:40 PM Kashyap Chamarthy <kchamart@redhat.com> wrote:

> On Wed, Mar 30, 2022 at 02:24:20PM -0400, John Snow wrote:
> > The README here will reflect both what is shown on GitLab and on the
> > PyPI landing page. Update it accordingly, and freshen it up.
> >
> > FIXME: Update URLs when pushing to the production repo.
> >
> > Suggested-by: Kashyap Chamarthy <kchamart@redhat.com>
> > Signed-off-by: John Snow <jsnow@redhat.com>
> > ---
>
> Hi,
>
> This version reads good to me. :)
>
> [...]
>
> > +
> > +Who isn't this library for?
> > +---------------------------
> > +
> > +It is not designed for anyone looking for a turn-key solution for VM
> > +management. QEMU is a low-level component that resembles a particularly
> > +impressive Swiss Army knife. This library does not manage that
> > +complexity and is largely "VM-ignorant". It's not a replacement for
> > +projects like `libvirt <https://libvirt.org/>`_, `virt-manager
> > +<https://virt-manager.org/>`_, `GNOME Boxes
> > +<https://wiki.gnome.org/Apps/Boxes>`_, etc.
> > +
> > +
> > +Installing
> > +----------
> > +
> > +This package can be installed from PyPI with pip: ``> pip3 install
> > +qemu.qmp``.
> >
> > +
> > +Usage
> > +-----
> > +
> > +Launch QEMU with a monitor, e.g.::
> > +
> > +  > qemu-system-x86_64 -qmp unix:qmp.sock,server=on,wait=off
> > +
> > +
> > +Then, at its simplest, script-style usage looks like this::
> > +
> > +  import asyncio
> > +  from qemu.qmp import QMPClient
> > +
> > +  async def main():
> > +      qmp = QMPClient('my-vm-nickname')
> > +      await qmp.connect('qmp.sock')
> > +
> > +      res = await qmp.execute('query-status')
> > +      print(f"VM status: {res['status']}")
> > +
> > +      await qmp.disconnect()
> > +
> > +  asyncio.run(main())
>
> Tested the exmaple; this works!
>
> > +The above script will connect to the UNIX socket located at
> > +``qmp.sock``, query the VM's runstate, then print it out
> > +to the terminal::
> > +
> > +  > python3 example.py
> > +  VM status: running
> > +
> > +
> > +For more complex usages, especially those that make full advantage of
> > +monitoring asynchronous events, refer to the `online documentation
> > +<https://jsnow.gitlab.io/qemu.qmp/>`_ or type ``import qemu.qmp;
> > +help(qemu.qmp)`` in your Python terminal of choice.
> > +
> > +
> > +Contributing
> > +------------
> > +
> > +Contributions are quite welcome! Please file bugs using the `GitLab
> > +issue tracker <https://gitlab.com/jsnow/qemu.qmp/-/issues>`_. This
> > +project will accept GitLab merge requests, but due to the close
> > +association with the QEMU project, there are some additional guidelines:
> > +
> > +1. Please use the "Signed-off-by" tag in your commit messages. See
> > +   https://wiki.linuxfoundation.org/dco for more information on this
> > +   requirement.
> > +
> > +2. This repository won't squash merge requests into a single commit on
> > +   pull; each commit should seek to be self-contained (within reason).
> > +
> > +3. Owing to the above, each commit sent as part of a merge request
> > +   should not introduce any temporary regressions, even if fixed later
> > +   in the same merge request. This is done to preserve bisectability.
> > +
> > +4. Please associate every merge request with at least one `GitLab issue
> > +   <https://gitlab.com/jsnow/qemu.qmp/-/issues>`_. This helps with
> > +   generating Changelog text and staying organized. Thank you 🙇
>
> /me didn't miss the Japanese bow.
>
> > +Developing
> > +^^^^^^^^^^
> > +
> > +Optional packages necessary for running code quality analysis for this
> > +package can be installed with the optional dependency group "devel":
> > +``pip install qemu.qmp[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. Consult ``make
> > +help`` for other targets and tests that make sense for different
> > +occasions.
> > +
> > +Before submitting a pull request, consider running ``make check-tox &&
> > +make check-pipenv`` locally to spot any issues that will cause the CI to
> > +fail. These checks use their own virtual environments and won't pollute
> > +your working space.
>
> Nit: Consider hyper-linking "virtual environments" to:
> https://docs.python.org/3/library/venv.html#module-venv
>
> (I realize, within context people will recognize the term "virtual
> environment" is not a virtual guest environment, but a Python venv.  I
> have a mild preference for being explicit here.)
>

OK. it's tough: there's a dual audience in mind here. People who are
familiar with Python development and QEMU devs who are not!

A link would suffice, but how to install, develop, and use python packages
can get a little complex. Longer than a paragraph, anyway.

Hard to know which complexities to omit and which to front-load.

¯\_(ツ)_/¯


> FWIW:
>
> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>


Thanks for your review prior to sending, and thanks for your re-review here
🙂


>
> [...]
>
>
> --
> /kashyap
>
>

[-- Attachment #2: Type: text/html, Size: 8015 bytes --]

^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git
  2022-04-01 17:05   ` Kashyap Chamarthy
@ 2022-04-04 18:54     ` John Snow
  2022-04-04 18:56       ` John Snow
  0 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-04-04 18:54 UTC (permalink / raw)
  To: Kashyap Chamarthy
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

On Fri, Apr 1, 2022 at 1:05 PM Kashyap Chamarthy <kchamart@redhat.com> wrote:
>
> On Wed, Mar 30, 2022 at 02:24:13PM -0400, John Snow wrote:
> > Split python/ from qemu.git, using these commands:
> >
> > > git subtree split -P python/ -b python-split-v3
> > > mkdir ~/src/tmp
> > > cd ~/src/tmp
> > > git clone --no-local --branch python-split-v3 --single-branch ~/src/qemu
> > > cd qemu
> > > git filter-repo --path qemu/machine/           \
> >                   --path qemu/utils/             \
> >                   --path tests/iotests-mypy.sh   \
> >                   --path tests/iotests-pylint.sh \
> >                   --invert-paths
> >
> > This commit, however, only performs some minimum cleanup to reflect the
> > deletion of the other subpackages. It is not intended to be exhaustive,
> > and further edits are made in forthcoming commits.
> >
> > These fixes are broken apart into micro-changes to facilitate mailing
> > list review subject-by-subject. They *could* be squashed into a single
> > larger commit on merge if desired, but due to the nature of the fork,
> > bisectability across the fork boundary is going to be challenging
> > anyway. It may be better value to just leave these initial commits
> > as-is.
> >
> > Signed-off-by: John Snow <jsnow@redhat.com>
> > ---
> >  .gitignore |  2 +-
> >  Makefile   | 16 ++++++++--------
> >  setup.cfg  | 24 +-----------------------
> >  setup.py   |  2 +-
> >  4 files changed, 11 insertions(+), 33 deletions(-)
>
> The changes here look fine to me (and thanks for making it a "micro
> change").  I'll let sharper eyes than mine to give a closer look at the
> `git filter-repo` surgery.  Although, that looks fine to me too.
>
> [...]
>
> >  .PHONY: distclean
> >  distclean: clean
> > -     rm -rf qemu.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > +     rm -rf qemu.qmp.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> >       rm -f .coverage .coverage.*
> >       rm -rf htmlcov/
> > diff --git a/setup.cfg b/setup.cfg
> > index e877ea5..4ffab73 100644
> > --- a/setup.cfg
> > +++ b/setup.cfg
> > @@ -1,5 +1,5 @@
> >  [metadata]
> > -name = qemu
> > +name = qemu.qmp
> >  version = file:VERSION
> >  maintainer = QEMU Developer Team
>
> In the spirit of patch 04 ("update maintainer metadata"), do you also
> want to update here too? s/QEMU Developer Team/QEMU Project?
>

Good spot.

> FWIW:
>
> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
>
> [...]
>
> --
> /kashyap
>



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git
  2022-04-04 18:54     ` John Snow
@ 2022-04-04 18:56       ` John Snow
  2022-04-05  8:50         ` Kashyap Chamarthy
  0 siblings, 1 reply; 25+ messages in thread
From: John Snow @ 2022-04-04 18:56 UTC (permalink / raw)
  To: Kashyap Chamarthy
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

On Mon, Apr 4, 2022 at 2:54 PM John Snow <jsnow@redhat.com> wrote:
>
> On Fri, Apr 1, 2022 at 1:05 PM Kashyap Chamarthy <kchamart@redhat.com> wrote:
> >
> > On Wed, Mar 30, 2022 at 02:24:13PM -0400, John Snow wrote:
> > > Split python/ from qemu.git, using these commands:
> > >
> > > > git subtree split -P python/ -b python-split-v3
> > > > mkdir ~/src/tmp
> > > > cd ~/src/tmp
> > > > git clone --no-local --branch python-split-v3 --single-branch ~/src/qemu
> > > > cd qemu
> > > > git filter-repo --path qemu/machine/           \
> > >                   --path qemu/utils/             \
> > >                   --path tests/iotests-mypy.sh   \
> > >                   --path tests/iotests-pylint.sh \
> > >                   --invert-paths
> > >
> > > This commit, however, only performs some minimum cleanup to reflect the
> > > deletion of the other subpackages. It is not intended to be exhaustive,
> > > and further edits are made in forthcoming commits.
> > >
> > > These fixes are broken apart into micro-changes to facilitate mailing
> > > list review subject-by-subject. They *could* be squashed into a single
> > > larger commit on merge if desired, but due to the nature of the fork,
> > > bisectability across the fork boundary is going to be challenging
> > > anyway. It may be better value to just leave these initial commits
> > > as-is.
> > >
> > > Signed-off-by: John Snow <jsnow@redhat.com>
> > > ---
> > >  .gitignore |  2 +-
> > >  Makefile   | 16 ++++++++--------
> > >  setup.cfg  | 24 +-----------------------
> > >  setup.py   |  2 +-
> > >  4 files changed, 11 insertions(+), 33 deletions(-)
> >
> > The changes here look fine to me (and thanks for making it a "micro
> > change").  I'll let sharper eyes than mine to give a closer look at the
> > `git filter-repo` surgery.  Although, that looks fine to me too.
> >
> > [...]
> >
> > >  .PHONY: distclean
> > >  distclean: clean
> > > -     rm -rf qemu.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > > +     rm -rf qemu.qmp.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > >       rm -f .coverage .coverage.*
> > >       rm -rf htmlcov/
> > > diff --git a/setup.cfg b/setup.cfg
> > > index e877ea5..4ffab73 100644
> > > --- a/setup.cfg
> > > +++ b/setup.cfg
> > > @@ -1,5 +1,5 @@
> > >  [metadata]
> > > -name = qemu
> > > +name = qemu.qmp
> > >  version = file:VERSION
> > >  maintainer = QEMU Developer Team
> >
> > In the spirit of patch 04 ("update maintainer metadata"), do you also
> > want to update here too? s/QEMU Developer Team/QEMU Project?
> >
>
> Good spot.

...Or, uh. That's exactly what I update in patch 04. Are you asking me
to fold in that change earlier? I'm confused now.

--js



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git
  2022-04-04 18:56       ` John Snow
@ 2022-04-05  8:50         ` Kashyap Chamarthy
  2022-04-05 15:28           ` John Snow
  0 siblings, 1 reply; 25+ messages in thread
From: Kashyap Chamarthy @ 2022-04-05  8:50 UTC (permalink / raw)
  To: John Snow
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

On Mon, Apr 04, 2022 at 02:56:10PM -0400, John Snow wrote:
> On Mon, Apr 4, 2022 at 2:54 PM John Snow <jsnow@redhat.com> wrote:

[...]

> > > >  .gitignore |  2 +-
> > > >  Makefile   | 16 ++++++++--------
> > > >  setup.cfg  | 24 +-----------------------
> > > >  setup.py   |  2 +-
> > > >  4 files changed, 11 insertions(+), 33 deletions(-)
> > >
> > > The changes here look fine to me (and thanks for making it a "micro
> > > change").  I'll let sharper eyes than mine to give a closer look at the
> > > `git filter-repo` surgery.  Although, that looks fine to me too.
> > >
> > > [...]
> > >
> > > >  .PHONY: distclean
> > > >  distclean: clean
> > > > -     rm -rf qemu.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > > > +     rm -rf qemu.qmp.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > > >       rm -f .coverage .coverage.*
> > > >       rm -rf htmlcov/
> > > > diff --git a/setup.cfg b/setup.cfg
> > > > index e877ea5..4ffab73 100644
> > > > --- a/setup.cfg
> > > > +++ b/setup.cfg
> > > > @@ -1,5 +1,5 @@
> > > >  [metadata]
> > > > -name = qemu
> > > > +name = qemu.qmp
> > > >  version = file:VERSION
> > > >  maintainer = QEMU Developer Team
> > >
> > > In the spirit of patch 04 ("update maintainer metadata"), do you also
> > > want to update here too? s/QEMU Developer Team/QEMU Project?
> > >
> >
> > Good spot.
> 
> ...Or, uh. That's exactly what I update in patch 04. Are you asking me
> to fold in that change earlier? I'm confused now.

Oops, perils of reviewing late in the day.  I missed to notice it's the
same file.  You're right; please ignore my remark.  Sorry for the noise.
 

-- 
/kashyap



^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 10/13] docs: add versioning policy to README
  2022-03-30 18:24 ` [qemu.qmp PATCH 10/13] docs: add versioning policy to README John Snow
@ 2022-04-05  9:16   ` Damien Hedde
  2022-04-05 15:47     ` John Snow
  0 siblings, 1 reply; 25+ messages in thread
From: Damien Hedde @ 2022-04-05  9:16 UTC (permalink / raw)
  To: John Snow, qemu-devel
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy,
	Markus Armbruster, Cleber Rosa, Eric Blake



On 3/30/22 20:24, John Snow wrote:
> The package is in an alpha state, but there's a method to the madness.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   README.rst | 21 +++++++++++++++++++++
>   1 file changed, 21 insertions(+)
> 
> diff --git a/README.rst b/README.rst
> index 8593259..88efe84 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -154,6 +154,27 @@ fail. These checks use their own virtual environments and won't pollute
>   your working space.
>   
>   
> +Stability and Versioning
> +------------------------
> +
> +This package uses a major.minor.micro SemVer versioning, with the
> +following additional semantics during the alpha/beta period (Major
> +version 0):
> +
> +This package treats 0.0.z versions as "alpha" versions. Each micro
> +version update may change the API incompatibly. Early users are advised
> +to pin against explicit versions, but check for updates often.
> +
> +A planned 0.1.z version will introduce the first "beta", whereafter each
> +micro update will be backwards compatible, but each minor update will
> +not be. The first beta version will be released after legacy.py is
> +removed, and the API is tentatively "stable".
> +
> +Thereafter, normal SemVer/PEP440 rules will apply; micro updates will
> +always be bugfixes, and minor updates will be reserved for backwards
> +compatible feature changes.
> +
> +
>   Changelog
>   ---------
>   

Looks reasonable to me.
Reviewed-by: Damien Hedde <damien.hedde@greensocs.com>


^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git
  2022-04-05  8:50         ` Kashyap Chamarthy
@ 2022-04-05 15:28           ` John Snow
  0 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-04-05 15:28 UTC (permalink / raw)
  To: Kashyap Chamarthy
  Cc: Daniel Berrange, Beraldo Leal, qemu-devel, Markus Armbruster,
	Cleber Rosa, Eric Blake

[-- Attachment #1: Type: text/plain, Size: 2624 bytes --]

On Tue, Apr 5, 2022, 4:51 AM Kashyap Chamarthy <kchamart@redhat.com> wrote:

> On Mon, Apr 04, 2022 at 02:56:10PM -0400, John Snow wrote:
> > On Mon, Apr 4, 2022 at 2:54 PM John Snow <jsnow@redhat.com> wrote:
>
> [...]
>
> > > > >  .gitignore |  2 +-
> > > > >  Makefile   | 16 ++++++++--------
> > > > >  setup.cfg  | 24 +-----------------------
> > > > >  setup.py   |  2 +-
> > > > >  4 files changed, 11 insertions(+), 33 deletions(-)
> > > >
> > > > The changes here look fine to me (and thanks for making it a "micro
> > > > change").  I'll let sharper eyes than mine to give a closer look at
> the
> > > > `git filter-repo` surgery.  Although, that looks fine to me too.
> > > >
> > > > [...]
> > > >
> > > > >  .PHONY: distclean
> > > > >  distclean: clean
> > > > > -     rm -rf qemu.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > > > > +     rm -rf qemu.qmp.egg-info/ .venv/ .tox/ $(QEMU_VENV_DIR) dist/
> > > > >       rm -f .coverage .coverage.*
> > > > >       rm -rf htmlcov/
> > > > > diff --git a/setup.cfg b/setup.cfg
> > > > > index e877ea5..4ffab73 100644
> > > > > --- a/setup.cfg
> > > > > +++ b/setup.cfg
> > > > > @@ -1,5 +1,5 @@
> > > > >  [metadata]
> > > > > -name = qemu
> > > > > +name = qemu.qmp
> > > > >  version = file:VERSION
> > > > >  maintainer = QEMU Developer Team
> > > >
> > > > In the spirit of patch 04 ("update maintainer metadata"), do you also
> > > > want to update here too? s/QEMU Developer Team/QEMU Project?
> > > >
> > >
> > > Good spot.
> >
> > ...Or, uh. That's exactly what I update in patch 04. Are you asking me
> > to fold in that change earlier? I'm confused now.
>
> Oops, perils of reviewing late in the day.  I missed to notice it's the
> same file.  You're right; please ignore my remark.  Sorry for the noise.
>

I made the same mistake upon reading the feedback, so we're both guilty 😅

Thanks Kashyap, I appreciate the review.

There's three more series here to apply to the new forked package (not yet
re-sent to the ML):

(2) Adding GitLab CI configuration. Not relevant for you, probably.

(3) Adding Sphinx documentation. This builds jsnow.gitlab.io/qemu.qmp/ -
I'd be appreciative of your feedback on this. I'm interested both in
proofreading and in design feedback here. All comments welcome.

[Though more rigorous changes to the design might be a "later" thing, but
the feedback is welcomed all the same.]

(4) Adding automatic package builds and git-based versioning to GitLab.
Maybe also not too relevant for you. 🙂


>
>
> --
> /kashyap
>

Thanks for your time!

[-- Attachment #2: Type: text/html, Size: 4330 bytes --]

^ permalink raw reply	[flat|nested] 25+ messages in thread

* Re: [qemu.qmp PATCH 10/13] docs: add versioning policy to README
  2022-04-05  9:16   ` Damien Hedde
@ 2022-04-05 15:47     ` John Snow
  0 siblings, 0 replies; 25+ messages in thread
From: John Snow @ 2022-04-05 15:47 UTC (permalink / raw)
  To: Damien Hedde
  Cc: Daniel Berrange, Beraldo Leal, Kashyap Chamarthy,
	Markus Armbruster, qemu-devel, Cleber Rosa, Eric Blake

[-- Attachment #1: Type: text/plain, Size: 2326 bytes --]

On Tue, Apr 5, 2022, 5:16 AM Damien Hedde <damien.hedde@greensocs.com>
wrote:

>
>
> On 3/30/22 20:24, John Snow wrote:
> > The package is in an alpha state, but there's a method to the madness.
> >
> > Signed-off-by: John Snow <jsnow@redhat.com>
> > ---
> >   README.rst | 21 +++++++++++++++++++++
> >   1 file changed, 21 insertions(+)
> >
> > diff --git a/README.rst b/README.rst
> > index 8593259..88efe84 100644
> > --- a/README.rst
> > +++ b/README.rst
> > @@ -154,6 +154,27 @@ fail. These checks use their own virtual
> environments and won't pollute
> >   your working space.
> >
> >
> > +Stability and Versioning
> > +------------------------
> > +
> > +This package uses a major.minor.micro SemVer versioning, with the
> > +following additional semantics during the alpha/beta period (Major
> > +version 0):
> > +
> > +This package treats 0.0.z versions as "alpha" versions. Each micro
> > +version update may change the API incompatibly. Early users are advised
> > +to pin against explicit versions, but check for updates often.
> > +
> > +A planned 0.1.z version will introduce the first "beta", whereafter each
> > +micro update will be backwards compatible, but each minor update will
> > +not be. The first beta version will be released after legacy.py is
> > +removed, and the API is tentatively "stable".
> > +
> > +Thereafter, normal SemVer/PEP440 rules will apply; micro updates will
> > +always be bugfixes, and minor updates will be reserved for backwards
> > +compatible feature changes.
> > +
> > +
> >   Changelog
> >   ---------
> >
>
> Looks reasonable to me.
> Reviewed-by: Damien Hedde <damien.hedde@greensocs.com>
>

Thanks! I'm hoping to make it easier to spin up more dev tooling outside of
the qemu tree. If you've got any wishlist items, feel free to let me know.

It's still early days for Python packages outside of the qemu tree, so
nearly everything is on the table still.

(the jsnow/python staging branch has some 17 patches in it that will be
checked in to QEMU when development re-opens. The forked qemu.qmp repo will
be based off of qemu.git after those patches go in. There's a bit of
shakeup where I delete the old qmp lib and replace it with what's currently
aqmp. It should hopefully not be a huge nuisance to your work, but if
there's issues, let me know.)

Thanks,
--John Snow

[-- Attachment #2: Type: text/html, Size: 3512 bytes --]

^ permalink raw reply	[flat|nested] 25+ messages in thread

end of thread, other threads:[~2022-04-05 15:47 UTC | newest]

Thread overview: 25+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-30 18:24 [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 01/13] pylint hotfix John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git John Snow
2022-04-01 17:05   ` Kashyap Chamarthy
2022-04-04 18:54     ` John Snow
2022-04-04 18:56       ` John Snow
2022-04-05  8:50         ` Kashyap Chamarthy
2022-04-05 15:28           ` John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 03/13] update VERSION to 0.0.0a1 John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 04/13] update maintainer metadata John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 05/13] update project description John Snow
2022-04-01 16:52   ` Beraldo Leal
2022-03-30 18:24 ` [qemu.qmp PATCH 06/13] [FIXME] update project URLs John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 07/13] add a couple new trove classifiers John Snow
2022-04-01 16:54   ` Beraldo Leal
2022-03-30 18:24 ` [qemu.qmp PATCH 08/13] move README.rst to FILES.rst and update John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst " John Snow
2022-04-01 16:40   ` Kashyap Chamarthy
2022-04-01 17:31     ` John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 10/13] docs: add versioning policy to README John Snow
2022-04-05  9:16   ` Damien Hedde
2022-04-05 15:47     ` John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 11/13] add LGPLv2+ and GPLv2 LICENSE files John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 12/13] update Pipfile John Snow
2022-03-30 18:24 ` [qemu.qmp PATCH 13/13] remove sub-dependency pins from Pipfile John Snow

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.