CHANGELOG.md installed into top-level site-packages directory

mjpieters / aiolimiter

An efficient implementation of a rate limiter for asyncio.

https://aiolimiter.readthedocs.io/en/latest/

MIT License

512 stars 22 forks source link

Closed vimproved closed 5 months ago

vimproved commented 10 months ago

Currently, the pyproject.toml file is causing poetry to install CHANGELOG.md top-level into the site-packages directory when built (e.g. /usr/lib/python3.11/site-packages/CHANGELOG.md). See https://projects.gentoo.org/python/guide/qawarn.html#documentation-files-installed-by-poetry for more info. The fix is as follows:

In pyproject.toml, replace include = ["CHANGELOG.md"] with


include = [
    { path = "CHANGELOG.md", format = "sdist" },
]

mjpieters commented 5 months ago

Thanks! This was fixed (somewhat inadvertently) in b3c6602e32bd78710812582d06b2dec2232f5d9b.