Script 'mail_helper' called by obssrc Hello community, here is the log from the commit of package python-click-man for openSUSE:Factory checked in at 2025-04-15 16:47:14 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/python-click-man (Old) and /work/SRC/openSUSE:Factory/.python-click-man.new.1907 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-click-man" Tue Apr 15 16:47:14 2025 rev:5 rq:1269459 version:0.5.1 Changes: -------- --- /work/SRC/openSUSE:Factory/python-click-man/python-click-man.changes 2025-02-11 21:30:24.760583995 +0100 +++ /work/SRC/openSUSE:Factory/.python-click-man.new.1907/python-click-man.changes 2025-04-15 16:49:46.416793219 +0200 @@ -1,0 +2,10 @@ +Tue Apr 15 06:19:22 UTC 2025 - John Paul Adrian Glaubitz <adrian.glaub...@suse.com> + +- Update to 0.5.1 + * Bump workflow versions + * README: Remove references to Python 2 + * README: Update packaging overview + * fix: Correct entrypoint + * pre-commit: Bump versions + +------------------------------------------------------------------- Old: ---- click_man-0.5.0.tar.gz New: ---- click_man-0.5.1.tar.gz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ python-click-man.spec ++++++ --- /var/tmp/diff_new_pack.b2qtmb/_old 2025-04-15 16:49:46.944814852 +0200 +++ /var/tmp/diff_new_pack.b2qtmb/_new 2025-04-15 16:49:46.944814852 +0200 @@ -18,7 +18,7 @@ %{?sle15_python_module_pythons} Name: python-click-man -Version: 0.5.0 +Version: 0.5.1 Release: 0 Summary: Automate generation of man pages for python click applications License: MIT ++++++ click_man-0.5.0.tar.gz -> click_man-0.5.1.tar.gz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/click_man-0.5.0/PKG-INFO new/click_man-0.5.1/PKG-INFO --- old/click_man-0.5.0/PKG-INFO 2024-12-11 15:18:24.912728300 +0100 +++ new/click_man-0.5.1/PKG-INFO 2025-04-08 16:40:35.724118200 +0200 @@ -1,6 +1,6 @@ -Metadata-Version: 2.1 +Metadata-Version: 2.4 Name: click-man -Version: 0.5.0 +Version: 0.5.1 Summary: Generate man pages for click based CLI applications Author-email: Timo Furrer <tuxt...@gmail.com> Maintainer-email: Timo Furrer <tuxt...@gmail.com>, Stephen Finucane <step...@that.guru> @@ -17,6 +17,7 @@ Description-Content-Type: text/markdown License-File: LICENSE Requires-Dist: click +Dynamic: license-file # click-man @@ -39,23 +40,16 @@ ## Installation ```bash -pip3 install click-man -``` - -**click-man** is also available for Python 2: - -```bash pip install click-man ``` -## Usage Recipes +## Usage The following sections describe different usage example for *click-man*. -### Use with a previously installed package +### CLI -**click-man** provides its own command line tool which can be passed the name of -an installed script: +**click-man** provides its own command line tool which can be passed the name of an installed script: ```bash click-man commandname @@ -69,17 +63,57 @@ click-man --target path/to/man/pages commandname ``` +You can use the `manpath` command or `MANPATH` environment variable to identify where man pages can be placed. + ### Automatic man page installation with setuptools and pip -This approach of installing man pages is problematic for various reasons: +While earlier version of click-man provided a distutils hook that could be used to automatically install man pages, +this approach had a number of caveats as outlined [below][issues-with-automatic-man-page-installation]. +distutils was removed from Python stdlib in Python 3.12 and the distutils hook was removed from **click-man** in v0.5.0. + +### Debian packages + +The `debhelper` packages provides a very convenient script called `dh_installman`. +It checks for the `debian/(pkg_name.)manpages` file and it's content which is basically a line by line list of man pages or globs: + +``` +debian/tmp/manpages/* +``` + +We override the rule provided by `dh_installman` to generate our man pages in advance, like this: + +```Makefile +override_dh_installman: + click-man <executable> --target debian/tmp/manpages + dh_installman -O--buildsystem=pybuild +``` + +Now we are able to build a Debian package with the tool of our choice, e.g.: + +```bash +debuild -us -uc +``` + +Checkout a working example here: [repo debian package](https://github.com/click-contrib/click-man/tree/master/examples/debian_pkg) + +### Other distro packages + +To include man pages in packages for other package managers like `dnf`, `zypper`, or `pacman`, you will likely need to do one of the following: + +* For upstream maintainers: generate man pages as part of a build release process and include them in version control or your generated sdists +* For packagers: generate man pages as part of the package build process and include these in the RPMs or tarballs, along with the relevant stanzas in the package definition -#### (1) Man pages are a UNIX thing +If you are packaging utilities, we would welcome PRs documenting best practices for those using **click-man** to document their utilities. + +## Issues with automatic man page installation + +### Man pages are a UNIX thing Python in general and with that pip and setuptools are aimed to be platform independent. Man pages are **not**: they are a UNIX thing which means setuptools does not provide a sane solution to generate and install man pages. We should consider using automatic man page installation only with vendor specific packaging, e.g. for `*.deb` or `*.rpm` packages. -#### (2) Man pages are not compatible with Python virtualenvs +### Man pages are not compatible with Python virtualenvs Even on systems that support man pages, Python packages can be installed in virtualenvs via pip and setuptools, which do not make commands available @@ -92,7 +126,7 @@ system, there is no guarantee that a globally installed man page will document the version and behavior available in any given virtualenv. -#### (3) We want to generate man pages on the fly +### We want to generate man pages on the fly First, we do not want to commit man pages to our source control. We want to generate them on the fly, either during build or installation time. @@ -101,26 +135,3 @@ 1. If we generate and install them during installation of the package pip does not know about the man pages and thus cannot uninstall it. 2. If we generate them in our build process and add them to your distribution we do not have a way to prevent installation to */usr/share/man* for non-UNIX-like Operating Systems or from within virtualenvs. - -### Debian packages - -The `debhelper` packages provides a very convenient script called `dh_installman`. -It checks for the `debian/(pkg_name.)manpages` file and it's content which is basically a line by line list of man pages or globs: - -``` -debian/tmp/manpages/* -``` - -We override the rule provided by `dh_installman` to generate our man pages in advance, like this: - -```Makefile -override_dh_installman: - click-man <executable> --target debian/tmp/manpages - dh_installman -O--buildsystem=pybuild -``` - -Now we are able to build a debian package with the tool of our choice, e.g.: - -```debuild -us -uc``` - -Checkout a working example here: [repo debian package](https://github.com/click-contrib/click-man/tree/master/examples/debian_pkg) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/click_man-0.5.0/README.md new/click_man-0.5.1/README.md --- old/click_man-0.5.0/README.md 2024-12-11 15:05:23.000000000 +0100 +++ new/click_man-0.5.1/README.md 2024-12-11 15:44:29.000000000 +0100 @@ -19,23 +19,16 @@ ## Installation ```bash -pip3 install click-man -``` - -**click-man** is also available for Python 2: - -```bash pip install click-man ``` -## Usage Recipes +## Usage The following sections describe different usage example for *click-man*. -### Use with a previously installed package +### CLI -**click-man** provides its own command line tool which can be passed the name of -an installed script: +**click-man** provides its own command line tool which can be passed the name of an installed script: ```bash click-man commandname @@ -49,17 +42,57 @@ click-man --target path/to/man/pages commandname ``` +You can use the `manpath` command or `MANPATH` environment variable to identify where man pages can be placed. + ### Automatic man page installation with setuptools and pip -This approach of installing man pages is problematic for various reasons: +While earlier version of click-man provided a distutils hook that could be used to automatically install man pages, +this approach had a number of caveats as outlined [below][issues-with-automatic-man-page-installation]. +distutils was removed from Python stdlib in Python 3.12 and the distutils hook was removed from **click-man** in v0.5.0. + +### Debian packages + +The `debhelper` packages provides a very convenient script called `dh_installman`. +It checks for the `debian/(pkg_name.)manpages` file and it's content which is basically a line by line list of man pages or globs: + +``` +debian/tmp/manpages/* +``` + +We override the rule provided by `dh_installman` to generate our man pages in advance, like this: + +```Makefile +override_dh_installman: + click-man <executable> --target debian/tmp/manpages + dh_installman -O--buildsystem=pybuild +``` + +Now we are able to build a Debian package with the tool of our choice, e.g.: + +```bash +debuild -us -uc +``` + +Checkout a working example here: [repo debian package](https://github.com/click-contrib/click-man/tree/master/examples/debian_pkg) + +### Other distro packages + +To include man pages in packages for other package managers like `dnf`, `zypper`, or `pacman`, you will likely need to do one of the following: + +* For upstream maintainers: generate man pages as part of a build release process and include them in version control or your generated sdists +* For packagers: generate man pages as part of the package build process and include these in the RPMs or tarballs, along with the relevant stanzas in the package definition -#### (1) Man pages are a UNIX thing +If you are packaging utilities, we would welcome PRs documenting best practices for those using **click-man** to document their utilities. + +## Issues with automatic man page installation + +### Man pages are a UNIX thing Python in general and with that pip and setuptools are aimed to be platform independent. Man pages are **not**: they are a UNIX thing which means setuptools does not provide a sane solution to generate and install man pages. We should consider using automatic man page installation only with vendor specific packaging, e.g. for `*.deb` or `*.rpm` packages. -#### (2) Man pages are not compatible with Python virtualenvs +### Man pages are not compatible with Python virtualenvs Even on systems that support man pages, Python packages can be installed in virtualenvs via pip and setuptools, which do not make commands available @@ -72,7 +105,7 @@ system, there is no guarantee that a globally installed man page will document the version and behavior available in any given virtualenv. -#### (3) We want to generate man pages on the fly +### We want to generate man pages on the fly First, we do not want to commit man pages to our source control. We want to generate them on the fly, either during build or installation time. @@ -81,26 +114,3 @@ 1. If we generate and install them during installation of the package pip does not know about the man pages and thus cannot uninstall it. 2. If we generate them in our build process and add them to your distribution we do not have a way to prevent installation to */usr/share/man* for non-UNIX-like Operating Systems or from within virtualenvs. - -### Debian packages - -The `debhelper` packages provides a very convenient script called `dh_installman`. -It checks for the `debian/(pkg_name.)manpages` file and it's content which is basically a line by line list of man pages or globs: - -``` -debian/tmp/manpages/* -``` - -We override the rule provided by `dh_installman` to generate our man pages in advance, like this: - -```Makefile -override_dh_installman: - click-man <executable> --target debian/tmp/manpages - dh_installman -O--buildsystem=pybuild -``` - -Now we are able to build a debian package with the tool of our choice, e.g.: - -```debuild -us -uc``` - -Checkout a working example here: [repo debian package](https://github.com/click-contrib/click-man/tree/master/examples/debian_pkg) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/click_man-0.5.0/click_man.egg-info/PKG-INFO new/click_man-0.5.1/click_man.egg-info/PKG-INFO --- old/click_man-0.5.0/click_man.egg-info/PKG-INFO 2024-12-11 15:18:24.000000000 +0100 +++ new/click_man-0.5.1/click_man.egg-info/PKG-INFO 2025-04-08 16:40:35.000000000 +0200 @@ -1,6 +1,6 @@ -Metadata-Version: 2.1 +Metadata-Version: 2.4 Name: click-man -Version: 0.5.0 +Version: 0.5.1 Summary: Generate man pages for click based CLI applications Author-email: Timo Furrer <tuxt...@gmail.com> Maintainer-email: Timo Furrer <tuxt...@gmail.com>, Stephen Finucane <step...@that.guru> @@ -17,6 +17,7 @@ Description-Content-Type: text/markdown License-File: LICENSE Requires-Dist: click +Dynamic: license-file # click-man @@ -39,23 +40,16 @@ ## Installation ```bash -pip3 install click-man -``` - -**click-man** is also available for Python 2: - -```bash pip install click-man ``` -## Usage Recipes +## Usage The following sections describe different usage example for *click-man*. -### Use with a previously installed package +### CLI -**click-man** provides its own command line tool which can be passed the name of -an installed script: +**click-man** provides its own command line tool which can be passed the name of an installed script: ```bash click-man commandname @@ -69,17 +63,57 @@ click-man --target path/to/man/pages commandname ``` +You can use the `manpath` command or `MANPATH` environment variable to identify where man pages can be placed. + ### Automatic man page installation with setuptools and pip -This approach of installing man pages is problematic for various reasons: +While earlier version of click-man provided a distutils hook that could be used to automatically install man pages, +this approach had a number of caveats as outlined [below][issues-with-automatic-man-page-installation]. +distutils was removed from Python stdlib in Python 3.12 and the distutils hook was removed from **click-man** in v0.5.0. + +### Debian packages + +The `debhelper` packages provides a very convenient script called `dh_installman`. +It checks for the `debian/(pkg_name.)manpages` file and it's content which is basically a line by line list of man pages or globs: + +``` +debian/tmp/manpages/* +``` + +We override the rule provided by `dh_installman` to generate our man pages in advance, like this: + +```Makefile +override_dh_installman: + click-man <executable> --target debian/tmp/manpages + dh_installman -O--buildsystem=pybuild +``` + +Now we are able to build a Debian package with the tool of our choice, e.g.: + +```bash +debuild -us -uc +``` + +Checkout a working example here: [repo debian package](https://github.com/click-contrib/click-man/tree/master/examples/debian_pkg) + +### Other distro packages + +To include man pages in packages for other package managers like `dnf`, `zypper`, or `pacman`, you will likely need to do one of the following: + +* For upstream maintainers: generate man pages as part of a build release process and include them in version control or your generated sdists +* For packagers: generate man pages as part of the package build process and include these in the RPMs or tarballs, along with the relevant stanzas in the package definition -#### (1) Man pages are a UNIX thing +If you are packaging utilities, we would welcome PRs documenting best practices for those using **click-man** to document their utilities. + +## Issues with automatic man page installation + +### Man pages are a UNIX thing Python in general and with that pip and setuptools are aimed to be platform independent. Man pages are **not**: they are a UNIX thing which means setuptools does not provide a sane solution to generate and install man pages. We should consider using automatic man page installation only with vendor specific packaging, e.g. for `*.deb` or `*.rpm` packages. -#### (2) Man pages are not compatible with Python virtualenvs +### Man pages are not compatible with Python virtualenvs Even on systems that support man pages, Python packages can be installed in virtualenvs via pip and setuptools, which do not make commands available @@ -92,7 +126,7 @@ system, there is no guarantee that a globally installed man page will document the version and behavior available in any given virtualenv. -#### (3) We want to generate man pages on the fly +### We want to generate man pages on the fly First, we do not want to commit man pages to our source control. We want to generate them on the fly, either during build or installation time. @@ -101,26 +135,3 @@ 1. If we generate and install them during installation of the package pip does not know about the man pages and thus cannot uninstall it. 2. If we generate them in our build process and add them to your distribution we do not have a way to prevent installation to */usr/share/man* for non-UNIX-like Operating Systems or from within virtualenvs. - -### Debian packages - -The `debhelper` packages provides a very convenient script called `dh_installman`. -It checks for the `debian/(pkg_name.)manpages` file and it's content which is basically a line by line list of man pages or globs: - -``` -debian/tmp/manpages/* -``` - -We override the rule provided by `dh_installman` to generate our man pages in advance, like this: - -```Makefile -override_dh_installman: - click-man <executable> --target debian/tmp/manpages - dh_installman -O--buildsystem=pybuild -``` - -Now we are able to build a debian package with the tool of our choice, e.g.: - -```debuild -us -uc``` - -Checkout a working example here: [repo debian package](https://github.com/click-contrib/click-man/tree/master/examples/debian_pkg) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/click_man-0.5.0/click_man.egg-info/SOURCES.txt new/click_man-0.5.1/click_man.egg-info/SOURCES.txt --- old/click_man-0.5.0/click_man.egg-info/SOURCES.txt 2024-12-11 15:18:24.000000000 +0100 +++ new/click_man-0.5.1/click_man.egg-info/SOURCES.txt 2025-04-08 16:40:35.000000000 +0200 @@ -23,13 +23,13 @@ tests/__pycache__/__init__.cpython-312.pyc tests/__pycache__/__init__.cpython-313.pyc tests/__pycache__/__init__.cpython-39.pyc -tests/__pycache__/test_man.cpython-310-pytest-8.3.4.pyc -tests/__pycache__/test_man.cpython-311-pytest-8.3.4.pyc -tests/__pycache__/test_man.cpython-312-pytest-8.3.4.pyc -tests/__pycache__/test_man.cpython-313-pytest-8.3.4.pyc -tests/__pycache__/test_man.cpython-39-pytest-8.3.4.pyc -tests/__pycache__/test_shell.cpython-310-pytest-8.3.4.pyc -tests/__pycache__/test_shell.cpython-311-pytest-8.3.4.pyc -tests/__pycache__/test_shell.cpython-312-pytest-8.3.4.pyc -tests/__pycache__/test_shell.cpython-313-pytest-8.3.4.pyc -tests/__pycache__/test_shell.cpython-39-pytest-8.3.4.pyc \ No newline at end of file +tests/__pycache__/test_man.cpython-310-pytest-8.3.5.pyc +tests/__pycache__/test_man.cpython-311-pytest-8.3.5.pyc +tests/__pycache__/test_man.cpython-312-pytest-8.3.5.pyc +tests/__pycache__/test_man.cpython-313-pytest-8.3.5.pyc +tests/__pycache__/test_man.cpython-39-pytest-8.3.5.pyc +tests/__pycache__/test_shell.cpython-310-pytest-8.3.5.pyc +tests/__pycache__/test_shell.cpython-311-pytest-8.3.5.pyc +tests/__pycache__/test_shell.cpython-312-pytest-8.3.5.pyc +tests/__pycache__/test_shell.cpython-313-pytest-8.3.5.pyc +tests/__pycache__/test_shell.cpython-39-pytest-8.3.5.pyc \ No newline at end of file diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/click_man-0.5.0/click_man.egg-info/entry_points.txt new/click_man-0.5.1/click_man.egg-info/entry_points.txt --- old/click_man-0.5.0/click_man.egg-info/entry_points.txt 2024-12-11 15:18:24.000000000 +0100 +++ new/click_man-0.5.1/click_man.egg-info/entry_points.txt 2025-04-08 16:40:35.000000000 +0200 @@ -1,2 +1,2 @@ [console_scripts] -click-man = click_man.__main__:cli +click-man = click_man.shell:cli diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/click_man-0.5.0/pyproject.toml new/click_man-0.5.1/pyproject.toml --- old/click_man-0.5.0/pyproject.toml 2024-12-11 15:10:13.000000000 +0100 +++ new/click_man-0.5.1/pyproject.toml 2025-04-08 16:37:45.000000000 +0200 @@ -27,10 +27,10 @@ dependencies = [ "click", ] -version = "0.5.0" +version = "0.5.1" [project.scripts] -click-man = "click_man.__main__:cli" +click-man = "click_man.shell:cli" [project.urls] Source = "https://github.com/click-contrib/click-man" Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-310-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-310-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-310-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-310-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-311-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-311-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-311-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-311-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-312-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-312-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-312-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-312-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-313-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-313-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-313-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-313-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-39-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-39-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_man.cpython-39-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_man.cpython-39-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-310-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-310-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-310-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-310-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-311-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-311-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-311-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-311-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-312-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-312-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-312-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-312-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-313-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-313-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-313-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-313-pytest-8.3.5.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-39-pytest-8.3.4.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-39-pytest-8.3.4.pyc differ Binary files old/click_man-0.5.0/tests/__pycache__/test_shell.cpython-39-pytest-8.3.5.pyc and new/click_man-0.5.1/tests/__pycache__/test_shell.cpython-39-pytest-8.3.5.pyc differ