Add entry_points to setuptools’ configuration to provide command-line console scripts

[vitorsr]

Currently, PyMuPDF is not pipx-installable because it does not provide any console commands:

$ pipx install PyMuPDF

No apps associated with package pymupdf or its dependencies. If you are attempting to install a library, pipx should
not be used. Consider using pip or a similar tool instead.

To make, e.g., fitz, directly available from the command-line we need to add entry_points to setuptools’ configuration [1]:

        entry_points = {"console_scripts": ["fitz = fitz.__main__:main"]},

This would require modifying the pipcl.Package class.

It could alternatively be added to pyproject.toml [2]:

diff --git a/pyproject.toml b/pyproject.toml
index 10c9a43..05b7117 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -5,3 +5,6 @@ requires = ["libclang", "swig", "setuptools", "psutil"]
 #
 build-backend = "setup"
 backend-path = ["."]
+
+[project.scripts]
+fitz = fitz.__main__:main

[1] https://setuptools.pypa.io/en/latest/userguide/entry_point.html

[2] https://packaging.python.org/en/latest/specifications/pyproject-toml/#entry-points

[julian-smith-artifex-com]

Thanks for this, i didn't know about entry_points before.

In my tree i have added support for entry_points to pipcl.py and modified setup.py, so that installation gives a pymupdf command that runs fitz/main.py.

Depending on internal review, it might get included in the next release.

Thanks again.

[julian-smith-artifex-com]

Fixed in 1.23.26.

[vitorsr]

Thanks, Julian! Really appreciate all the good work on (Py-) MuPDF! Regards.

…

On Mon, Feb 26, 2024 at 7:28 PM Julian Smith ***@***.***> wrote: Thanks for this, i didn't know about entry_points before. In my tree i have added support for entry_points to pipcl.py and modified setup.py, so that installation gives a pymupdf command that runs fitz/ *main*.py. Depending on internal review, it might get included in the next release. Thanks again. — Reply to this email directly, view it on GitHub <#3199 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJW2VYOYDZPI367QXWAPZDTYVUEAXAVCNFSM6AAAAABDVNBWBGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRVGQZDONJXHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>