abey79 / vpype

The Swiss-Army-knife command-line tool for plotter vector graphics.
https://vpype.readthedocs.io/
MIT License
711 stars 63 forks source link

Site-packages pollution from README #743

Open 0x5c opened 5 months ago

0x5c commented 5 months ago

Usage of include in pyproject.toml for README and such is causing those files to be placed directly inside the site-packages directory once installed. That directory should only contain python modules and optionally their setuptools/pep517 metadata like *.dist-info files.

https://github.com/abey79/vpype/blob/3c1e08f302e32a423b0ce8a2532e298c88b2ce13/pyproject.toml#L22-L24

$ ls -1F venv/lib/python3.12/site-packages
CHANGELOG.md
LICENSE
PIL/
PySide6/
PySide6-6.7.0.dist-info/
PySide6_Addons-6.7.0.dist-info/
PySide6_Essentials-6.7.0.dist-info/
README.md
__pycache__/
_moderngl.py
[...]
vpype/
vpype-1.14.0.dist-info/
vpype_cli/
vpype_viewer/
wheel/
wheel-0.43.0.dist-info/

I'm not sure what would the solution be. The LICENSE file already gets properly installed to vpype-[verson].dist-info, so dropping those 3 lines from pyproject.toml could be a solution.