python: fork qemu.qmp python lib into independent repo
cover python: fork qemu.qmp python lib into independent repo
GitLab: https://gitlab.com/jsnow/qemu.qmp/-/commits/initial-checkin
Hi, this series is part of an effort to publish the qemu.qmp package on PyPI. It is part of the second of three phases to complete this work:
(1) Switch the new Async QMP library in to python/qemu/qmp [merged!]
(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 applies to the brand new repository.
If there are no objections, I intend to push the content of this branch to https://gitlab.com/qemu-project/python-qemu-qmp within a week or so.
Most URLs in this series have been updated to point to the new repo URL, except one link to https://jsnow.gitlab.io/qemu.qmp/ which will be updated when step (2c) above is handled.
John Snow (12):
fork qemu.qmp from qemu.git
update maintainer metadata
update project description
update project URLs
add a couple new trove classifiers
move README.rst to FILES.rst and update
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
update VERSION to 0.0.0a1
.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 | 272 ++++++++++++++++-------- VERSION | 2 +- qemu/qmp/__init__.py | 2 +- qemu/qmp/legacy.py | 2 +- qemu/qmp/qmp_shell.py | 2 +- qemu/qmp/qmp_tui.py | 2 +- setup.cfg | 41 ++-- setup.py | 2 +- 17 files changed, 1262 insertions(+), 306 deletions(-) create mode 100644 FILES.rst create mode 100644 LICENSE create mode 100644 LICENSE_GPL2 delete mode 100644 PACKAGE.rst
Signature · 1 line
2.34.1
PATCH 1/12 fork qemu.qmp from qemu.git
Split python/ from qemu.git, using these commands:
Quoted 6 lines
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-pathsThis 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.
--- .gitignore | 2 +- Makefile | 16 ++++++++-------- setup.cfg | 24 +----------------------- setup.py | 2 +- 4 files changed, 11 insertions(+), 33 deletions(-)
.gitignore +1 -1
@@ -5,7 +5,7 @@ # python packaging build/ dist/ -qemu.egg-info/ +qemu.qmp.egg-info/ # editor config .idea/
Makefile +8 -8
@@ -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/
setup.cfg +1 -23
@@ -1,5 +1,5 @@ [metadata] -name = qemu +name = qemu.qmp version = file:VERSION maintainer = QEMU Developer Team maintainer_email = [email protected]
@@ -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
setup.py +1 -1
@@ -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. """
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 01/12] fork qemu.qmp from qemu.git
Quoted 8 lines · John Snow
Split python/ from qemu.git, using these commands:
Quoted 6 lines
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/ \
Quoted 4 lines
--path qemu/utils/ \
--path tests/iotests-mypy.sh \
--path tests/iotests-pylint.sh \
--invert-pathsSo you're saying the repository is initialized with the output from the above commands, and then this commit is the first one on top of that.
Quoted 10 lines
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.
Yep, I think bisectability is impractical to achieve across this kind of split. I think the filtered git history is simply there as a way to give credit to the original authors, for historical research and to make 'git blame' work.
IOW, I'd declare bitsectability starts at the end of this patch series, as a goal.
Quoted 166 lines
Signed-off-by John Snow <[email protected]>Reviewed-by Kashyap Chamarthy <[email protected]>--- .gitignore | 2 +- Makefile | 16 ++++++++-------- setup.cfg | 24 +----------------------- setup.py | 2 +- 4 files changed, 11 insertions(+), 33 deletions(-).gitignore +1
-1@@ -5,7 +5,7 @@ # python packaging build/ dist/ -qemu.egg-info/ +qemu.qmp.egg-info/ # editor config .idea/Makefile +8
-8@@ -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/setup.cfg +1
-23@@ -1,5 +1,5 @@ [metadata] -name = qemu +name = qemu.qmp version = file:VERSION maintainer = QEMU Developer Team maintainer_email = [email protected]@@ -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 checksetup.py +1
-1@@ -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. """Signature · 1 line
2.34.1
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Re: [qemu.qmp PATCH 01/12] fork qemu.qmp from qemu.git
Quoted 10 lines · Daniel P. Berrangé
Quoted 6 lines · John Snow
Split python/ from qemu.git, using these commands:
Quoted 4 lines
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
Quoted 2 lines
Quoted 2 lines
cd qemu
git filter-repo --path qemu/machine/ \
Quoted 9 lines
Quoted 4 lines
--path qemu/utils/ \ --path tests/iotests-mypy.sh \ --path tests/iotests-pylint.sh \ --invert-pathsSo you're saying the repository is initialized with the output from the above commands, and then this commit is the first one on top of that.
Yeah. This was just my best guess at how to preserve development history and SOB credits.
Figured I'd document how the split was done in the commit so that was archived too.
Quoted 11 lines
Quoted 10 lines
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.
Quoted 8 lines
Yep, I think bisectability is impractical to achieve across this kind of split. I think the filtered git history is simply there as a way to give credit to the original authors, for historical research and to make 'git blame' work.
IOW, I'd declare bitsectability starts at the end of this patch series, as a goal.
That's the plan!
This series will mark 0.0.0a1 (no plans to publish) and then by the end of the subsequent checkins to add package builds, doc builds, ci etc I'll tag and publish a v0.0.1. (Possibily with a published v0.0.1a1 first to make sure everything is wired up right. This will also be useful for testing qemu.git changes to pull from PyPI.)
Quoted 181 lines
Quoted 37 lines
Signed-off-by John Snow <[email protected]>Reviewed-by Kashyap Chamarthy <[email protected]>--- .gitignore | 2 +- Makefile | 16 ++++++++-------- setup.cfg | 24 +----------------------- setup.py | 2 +- 4 files changed, 11 insertions(+), 33 deletions(-).gitignore +1
-1@@ -5,7 +5,7 @@ # python packaging build/ dist/ -qemu.egg-info/ +qemu.qmp.egg-info/ # editor config .idea/Makefile +1
-1@@ -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"Makefile help: · line 47
Quoted 6 lines
Makefile +1
-1@@ -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 'makeclean'."
Makefile dev-venv: $(QEMU_VENV_DIR)
Quoted 3 lines
Makefile +0
-0@echo "" @echo -e "Have a nice day ^_^\n"@@ -64,11 +64,11 @@ dev-venv: $(QEMU_VENV_DIR)$(QEMU_VENV_DIR)/bin/activate
Quoted 80 lines
Makefile +6
-6$(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/setup.cfg +1
-15@@ -1,5 +1,5 @@ [metadata] -name = qemu +name = qemu.qmp version = file:VERSION maintainer = QEMU Developer Team maintainer_email = [email protected]@@ -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 = Truesetup.cfg python_version = 3.6 · line 73
Quoted 10 lines
setup.cfg +0
-4-[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 librariesdo not
Quoted 28 lines
setup.cfg +0
-4# 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 checksetup.py +1
-2@@ -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. """ --Quoted 2 lines
2.34.1
With regards,
Daniel
--
|: https://berrange.com -o-
https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o-
https://fstop138.berrange.com :|
|: https://entangle-photo.org -o-
https://www.instagram.com/dberrange :|
PATCH 2/12 update maintainer metadata
In reply to John SnowModify "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.
--- setup.cfg | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
setup.cfg +4 -2
@@ -1,8 +1,10 @@ [metadata] name = qemu.qmp version = file:VERSION -maintainer = QEMU Developer Team -maintainer_email = [email protected] +author = QEMU Project +author_email = [email protected] +maintainer = John Snow +maintainer_email = [email protected] url = https://www.qemu.org/ download_url = https://www.qemu.org/download/ description = QEMU Python Build, Debug and SDK tooling.
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 02/12] update maintainer metadata
Quoted 9 lines · John Snow
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 <[email protected]>--- setup.cfg | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
Quoted 5 lines
setup.cfg +0
-0
setup.cfg line 7
Quoted 9 lines
setup.cfg +4
-2@@ -1,8 +1,10 @@ [metadata] name = qemu.qmp version = file:VERSION -maintainer = QEMU Developer Team -maintainer_email = [email protected] +author = QEMU Project +author_email = [email protected] +maintainer = John Snow +maintainer_email = [email protected]
It is up to you to decide, but beware that listing yourself here will result in random people emailing you directly to ask for help, instead of emailing the mailing list for help. Personally I always want people to use the mailing list and never mail me directly [1].
With regards,
Daniel
[1] https://rwmj.wordpress.com/2010/11/08/want-help-dont-email-me-directly/
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Re: [qemu.qmp PATCH 02/12] update maintainer metadata
Quoted 25 lines · Daniel P. Berrangé
Quoted 9 lines · John Snow
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 <[email protected]>--- setup.cfg | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 11 lines
setup.cfg +1
-2@@ -1,8 +1,10 @@ [metadata] name = qemu.qmp version = file:VERSION -maintainer = QEMU Developer Team -maintainer_email = [email protected] +author = QEMU Project
Quoted 9 lines
setup.cfg line 7
Quoted 3 lines
setup.cfg +3
-0+author_email = [email protected] +maintainer = John Snow +maintainer_email = [email protected]It is up to you to decide, but beware that listing yourself here will result in random people emailing you directly to ask for help, instead of emailing the mailing list for help. Personally I always want people to use the mailing list and never mail me directly [1].
Good point. I guess what I am afraid of is that they mail the list and don't CC me, and I miss it!
PATCH 3/12 update project description
In reply to John Snow--- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
setup.cfg +1 -1
@@ -7,7 +7,7 @@ maintainer = John Snow maintainer_email = [email protected] 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 =
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 03/12] update project description
Quoted 11 lines · John Snow
Signed-off-by John Snow <[email protected]>Reviewed-by Beraldo Leal <[email protected]>--- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)setup.cfg +0
-0
setup.cfg maintainer = John Snow · line 13
Quoted 8 lines
setup.cfg +1
-1@@ -7,7 +7,7 @@ maintainer = John Snow maintainer_email = [email protected] 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 =
--
Beraldo
PATCH 4/12 update project URLs
In reply to John SnowPoint to this library's URLs instead of the entire project's.
--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
setup.cfg +2 -2
@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url = https://gitlab.com/qemu-project/python-qemu-qmp/-/packages description = QEMU Monitor Protocol library long_description = file:PACKAGE.rst long_description_content_type = text/x-rst
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 04/12] update project URLs
Quoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0
setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url = https://gitlab.com/qemu-project/python-qemu-qmp/-/packages
Auto-generated tarballs are not guaranteed to have fixed content forever so I tend to avoid pointing to those. Assuming you're intending to upload to pypi, I'd link to that instead as the "official" tarball source.
setup.cfg author = QEMU Project · line 12
Quoted 3 lines
setup.cfg +0
-0description = QEMU Monitor Protocol library long_description = file:PACKAGE.rst long_description_content_type = text/x-rst
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Re: [qemu.qmp PATCH 04/12] update project URLs
Quoted 22 lines · Daniel P. Berrangé
Quoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url =
Quoted 4 lines
Auto-generated tarballs are not guaranteed to have fixed content forever so I tend to avoid pointing to those. Assuming you're intending to upload to pypi, I'd link to that instead as the "official" tarball source.
This metadata will also be used for PyPI, so that seemed cyclic.
I linked it to the gitlab package repository, where I *intend* to push built wheels (and dev interstitial builds) but maybe that's too "inside baseball" for a pypi link.
Seems weird for a Pypi package to point to itself on pypi, but maybe that's correct?
Quoted 16 lines
setup.cfg author = QEMU Project · line 12
Quoted 3 lines
setup.cfg +0
-0description = QEMU Monitor Protocol library long_description = file:PACKAGE.rst long_description_content_type = text/x-rstWith regards,
Daniel
--
|: https://berrange.com -o-
https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o-
https://fstop138.berrange.com :|
|: https://entangle-photo.org -o-
https://www.instagram.com/dberrange :|
Re: [qemu.qmp PATCH 04/12] update project URLs
Quoted 30 lines · John Snow
Quoted 22 lines · Daniel P. Berrangé
Quoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url =Quoted 4 lines
Auto-generated tarballs are not guaranteed to have fixed content forever so I tend to avoid pointing to those. Assuming you're intending to upload to pypi, I'd link to that instead as the "official" tarball source.
Quoted 5 lines
This metadata will also be used for PyPI, so that seemed cyclic.
I linked it to the gitlab package repository, where I *intend* to push built wheels (and dev interstitial builds) but maybe that's too "inside baseball" for a pypi link.
Oh wait, I mis-understood the URL. If it is the location for manually built & published dists, that's ok - it isn't the gitlab auto tarballs.
Quoted 2 lines
Seems weird for a Pypi package to point to itself on pypi, but maybe that's correct?
I wonder what common practice is for some popular python libs....
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Re: [qemu.qmp PATCH 04/12] update project URLs
Quoted 37 lines · Daniel P. Berrangé
Quoted 30 lines · John Snow
Quoted 22 lines · Daniel P. Berrangé
Quoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url =Quoted 4 lines
Auto-generated tarballs are not guaranteed to have fixed content forever so I tend to avoid pointing to those. Assuming you're intending to upload to pypi, I'd link to that instead as the "official" tarball source.
Quoted 5 lines
This metadata will also be used for PyPI, so that seemed cyclic.
I linked it to the gitlab package repository, where I *intend* to push built wheels (and dev interstitial builds) but maybe that's too "inside baseball" for a pypi link.
Quoted 7 lines
Oh wait, I mis-understood the URL. If it is the location for manually built & published dists, that's ok - it isn't the gitlab auto tarballs.
Quoted 2 lines
Seems weird for a Pypi package to point to itself on pypi, but maybe that's correct?
I wonder what common practice is for some popular python libs....
E.g. if you look at SQLAlchemy (definitely one of the popular libraries), it is pointing to itself (see the Ufiles under the "Download files" link):
https://pypi.org/project/SQLAlchemy
Signature · 1 line
/kashyap
Re: [qemu.qmp PATCH 04/12] update project URLs
Quoted 45 lines · Kashyap Chamarthy
Quoted 43 lines · Daniel P. Berrangé
Quoted 30 lines · John Snow
Quoted 22 lines · Daniel P. Berrangé
Quoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url =Quoted 4 lines
Auto-generated tarballs are not guaranteed to have fixed content forever so I tend to avoid pointing to those. Assuming you're intending to upload to pypi, I'd link to that instead as the "official" tarball source.
Quoted 5 lines
This metadata will also be used for PyPI, so that seemed cyclic.
I linked it to the gitlab package repository, where I *intend* to push built wheels (and dev interstitial builds) but maybe that's too "inside baseball" for a pypi link.
Oh wait, I mis-understood the URL. If it is the location for manually built & published dists, that's ok - it isn't the gitlab auto tarballs.
Quoted 2 lines
Seems weird for a Pypi package to point to itself on pypi, but maybe that's correct?
Quoted 8 lines
Quoted 1 line
I wonder what common practice is for some popular python libs....
E.g. if you look at SQLAlchemy (definitely one of the popular libraries), it is pointing to itself (see the Ufiles under the "Download files" link):
The "Files" link is, I believe, just a standard PyPI link. "Download" is the one being defined here.
Check out my "Alpha 0" page, generated earlier this year:
https://pypi.org/project/qemu.qmp/
Download Files goes to the PyPI section, but "Download" goes to the GitLab package registry.
I think I'll leave this as-is, then.
--js
Re: [qemu.qmp PATCH 04/12] update project URLs
In reply to John SnowQuoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0
setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url = https://gitlab.com/qemu-project/python-qemu-qmp/-/packages
Afaik (and I might be wrong), it seems that download_url is not recommended nowadays. External downloads got removed due to some abuse and problems.
I remember reading about some changes in the distribution of Python packages in PyPi where, by default, PyPi will not parse and expose "download_url" for newly registered packages anymore. From PEP438:
"Many package uploaders are not aware that specifying the “homepage” or “download-url” in their package metadata will needlessly slow down the installation process for all users."
Please take this comment with a grain of salt, I'm not 100% sure about this and I might be missing something.
--
Beraldo
Re: [qemu.qmp PATCH 04/12] update project URLs
Quoted 30 lines · Beraldo Leal
Quoted 12 lines · John Snow
Point to this library's URLs instead of the entire project's.
Signed-off-by John Snow <[email protected]>--- setup.cfg | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)setup.cfg +0
-0setup.cfg author = QEMU Project · line 9
Quoted 7 lines
setup.cfg +2
-2@@ -5,8 +5,8 @@ author = QEMU Project author_email = [email protected] maintainer = John Snow maintainer_email = [email protected] -url = https://www.qemu.org/ -download_url = https://www.qemu.org/download/ +url = https://gitlab.com/qemu-project/python-qemu-qmp +download_url = https://gitlab.com/qemu-project/python-qemu-qmp/-/packagesAfaik (and I might be wrong), it seems that
download_urlis not recommended nowadays. External downloads got removed due to some abuse and problems.I remember reading about some changes in the distribution of Python packages in PyPi where, by default, PyPi will not parse and expose "
download_url" for newly registered packages anymore. From PEP438:
Quoted 7 lines
"Many package uploaders are not aware that specifying the “homepage” or “download-url” in their package metadata will needlessly slow down the installation process for all users."
Please take this comment with a grain of salt, I'm not 100% sure about this and I might be missing something.
Neat. Good reference on PEP438. It was superseded:
https://peps.python.org/pep-0470/ ... but I am under the impression that pip does not have this behavior anymore. Maybe I'm wrong? I wasn't writing Python in 2014.
Though, I didn't realize that this field was *ever* used for external download links by package managers. Fun. I'll have to do some reading, but maybe I'll just remove the field for now, thanks for bringing this to my attention.
--js
PATCH 5/12 add a couple new trove classifiers
In reply to John Snow--- setup.cfg | 2 ++ 1 file changed, 2 insertions(+)
setup.cfg +2 -0
@@ -12,6 +12,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
@@ -21,6 +22,7 @@ classifiers = Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 Programming Language :: Python :: 3.10 + Topic :: System :: Emulators Typing :: Typed [options]
Signature · 1 line
2.34.1
PATCH 6/12 move README.rst to FILES.rst and update
In reply to John SnowThe 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.
--- README.rst => FILES.rst | 49 +++++++++++------------------------------ MANIFEST.in | 1 - 2 files changed, 13 insertions(+), 37 deletions(-) rename README.rst => FILES.rst (64%)
FILES.rst renamed from README.rst +13 -36
@@ -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``.
MANIFEST.in +0 -1
@@ -1,3 +1,2 @@ include VERSION include PACKAGE.rst -exclude README.rst
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 06/12] move README.rst to FILES.rst and update
Quoted 4 lines · John Snow
The intent is to use
README.rstas 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 toFILES.rstinstead, and update it accordingly.
Heh, I almost thought "git level readme" is a command similar to "git cuddle daemon" [1] :D
[1] https://git-man-page-generator.lokaltog.net/#Y3VkZGxlJCRkYWVtb24
Quoted 6 lines
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.
Quoted 6 lines
Signed-off-by John Snow <[email protected]>--- README.rst => FILES.rst | 49 +++++++++++------------------------------ MANIFEST.in | 1 - 2 files changed, 13 insertions(+), 37 deletions(-) rename README.rst => FILES.rst (64%)
As usual, thanks for the care for documentation.
[...]
Signature · 1 line
/kashyap
PATCH 7/12 move PACKAGE.rst to README.rst and update
In reply to John SnowThe README here will reflect both what is shown on GitLab and on the PyPI landing page. Update it accordingly, and freshen it up.
The documentation URL still points to my mirror, as the patches to establish sphinx as part of the build process aren't checked in yet, this will be updated later.
--- FILES.rst | 2 +- MANIFEST.in | 2 +- PACKAGE.rst | 43 -------------- README.rst | 163 ++++++++++++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 2 +- 5 files changed, 166 insertions(+), 46 deletions(-) delete mode 100644 PACKAGE.rst create mode 100644 README.rst
FILES.rst +1 -1
@@ -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
MANIFEST.in +1 -1
@@ -1,2 +1,2 @@ include VERSION -include PACKAGE.rst +include README.rst
PACKAGE.rst deleted +0 -43
43 lines not on this page · raw message
README.rst new file +163 -0
163 lines not on this page · raw message
setup.cfg +1 -1
@@ -8,7 +8,7 @@ maintainer_email = [email protected] url = https://gitlab.com/qemu-project/python-qemu-qmp download_url = https://gitlab.com/qemu-project/python-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
Signature · 1 line
2.34.1
PATCH 8/12 docs: add versioning policy to README
In reply to John SnowThe package is in an alpha state, but there's a method to the madness.
--- README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)
README.rst +22 -0
@@ -157,6 +157,28 @@ fail. These checks use their own `virtual environments working space. +Stability and Versioning +------------------------ + +This package uses a major.minor.micro `SemVer versioning +<https://semver.org/>`_, 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 <https://semver.org/>`_ / `PEP440 +<https://peps.python.org/pep-0440/>`_ rules will apply; micro updates +will always be bugfixes, and minor updates will be reserved for +backwards compatible feature changes. + + Changelog ---------
Signature · 1 line
2.34.1
PATCH 9/12 add LGPLv2+ and GPLv2 LICENSE files
In reply to John SnowThis 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 there 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.
--- 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
FILES.rst +3 -0
@@ -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
LICENSE new file +481 -0
481 lines not on this page · raw message
LICENSE_GPL2 new file +339 -0
339 lines not on this page · raw message
qemu/qmp/__init__.py +1 -1
@@ -19,7 +19,7 @@ managing QMP events. # Based on earlier work by Luiz Capitulino <[email protected]>. # # 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
qemu/qmp/legacy.py +1 -1
@@ -18,7 +18,7 @@ old interface. # John Snow <[email protected]> # # 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
qemu/qmp/qmp_shell.py +1 -1
@@ -6,7 +6,7 @@ # John Snow <[email protected]> # # 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. # """
qemu/qmp/qmp_tui.py +1 -1
@@ -4,7 +4,7 @@ # Niteesh Babu G S <[email protected]> # # 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
setup.cfg +1 -0
@@ -13,6 +13,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
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 09/12] add LGPLv2+ and GPLv2 LICENSE files
Quoted 15 lines · John Snow
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 there to point toLICENSE_GPL2, which is a copy of qemu.git's COPYING file.
legacy.pyis 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 <[email protected]>
Quoted 12 lines
--- 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
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH 10/12 update Pipfile
In reply to John SnowThe 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.)
--- Pipfile | 37 ++++++- Pipfile.lock | 288 ++++++++++++++++++++++++++++----------------------- 2 files changed, 195 insertions(+), 130 deletions(-)
Pipfile +35 -2
@@ -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"
Pipfile.lock +160 -128
430 lines not on this page · raw message
Signature · 1 line
2.34.1
PATCH 11/12 remove sub-dependency pins from Pipfile
In reply to John SnowNow 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.
--- Pipfile | 33 --------------------------------- 1 file changed, 33 deletions(-)
Pipfile +0 -33
@@ -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]
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 11/12] remove sub-dependency pins from Pipfile
Quoted 10 lines · John Snow
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 <[email protected]>
Makes sense.
PS: I see that you've also documented a summary version of Pipfile.lock
et al in FILES.txt; thank you.
[...]
Signature · 1 line
/kashyap
PATCH 12/12 update VERSION to 0.0.0a1
In reply to John Snowqemu.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 0.0.0 pre-release versions, will be buried after the first "real" release, expected to be 0.0.1.)
--- VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
VERSION +1 -1
@@ -1 +1 @@ -0.6.1.0a1 +0.0.0a1
Signature · 1 line
2.34.1
Re: [qemu.qmp PATCH 12/12] update VERSION to 0.0.0a1
Quoted 28 lines · John Snow
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 0.0.0 pre-release versions, will be buried after the first "real" release, expected to be 0.0.1.)
Signed-off-by John Snow <[email protected]>--- VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)VERSION +1
-1@@ -1 +1 @@ -0.6.1.0a1 +0.0.0a1Signature · 1 line
2.34.1
Makes sense,
--
Beraldo
Quoted 62 lines · John Snow
GitLab: https://gitlab.com/jsnow/qemu.qmp/-/commits/initial-checkin
Hi, this series is part of an effort to publish the qemu.qmp package on PyPI. It is part of the second of three phases to complete this work:
(1) Switch the new Async QMP library in to python/qemu/qmp [merged!]
(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 applies to the brand new repository.
If there are no objections, I intend to push the content of this branch to https://gitlab.com/qemu-project/python-qemu-qmp within a week or so.
Most URLs in this series have been updated to point to the new repo URL, except one link to https://jsnow.gitlab.io/qemu.qmp/ which will be updated when step (2c) above is handled.
John Snow (12):
fork qemu.qmp from qemu.git
update maintainer metadata
update project description
update project URLs
add a couple new trove classifiers
moveREADME.rsttoFILES.rstand update
movePACKAGE.rsttoREADME.rstand update
docs: add versioning policy to README
add LGPLv2+ and GPLv2 LICENSE files
update Pipfile
remove sub-dependency pins from Pipfile
update VERSION to 0.0.0a1.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 | 272 ++++++++++++++++-------- VERSION | 2 +- qemu/qmp/__init__.py | 2 +- qemu/qmp/legacy.py | 2 +- qemu/qmp/qmp_shell.py | 2 +- qemu/qmp/qmp_tui.py | 2 +- setup.cfg | 41 ++-- setup.py | 2 +- 17 files changed, 1262 insertions(+), 306 deletions(-) create mode 100644 FILES.rst create mode 100644 LICENSE create mode 100644 LICENSE_GPL2 delete mode 100644 PACKAGE.rst
Quoted 4 lines
--
2.34.1
Pushed directly as the initial commit.
https://gitlab.com/qemu-project/python-qemu-qmp
Thanks, everyone. I'll begin drafting and submitting merge requests for further work on this repository and, for now, CCing the mailing list pointing to the MRs.
--js