autoflake icon indicating copy to clipboard operation
autoflake copied to clipboard

LICENSE, README.md and test_autoflake.py included with install

Open gentlegiantJGC opened this issue 8 months ago • 4 comments

When installing autoflake the LICENSE, README.md and test_autoflake.py files are also installed into the root of the site-packages directory which seems like unintended behaviour.

Do you mean for this to happen?

gentlegiantJGC avatar May 09 '25 13:05 gentlegiantJGC

I installed with conda. LICENSE, README.md and test_autoflake.py files aren't also installed into the root of the site-packages directory. Can you pls try again? @gentlegiantJGC

venturero avatar Jun 01 '25 13:06 venturero

Hmm I think we want to distribute the license and the docs, though we should not include the tests, and we should make sure those files don't end-up in site-packages 🤔

fsouza avatar Jun 02 '25 05:06 fsouza

I am installing from pypi with pip. If you open the .whl file (eg with 7zip) you can see the contents that get extracted to the site-packages directory.

Image

If you want to distribute the licence and readme can I suggest making the library a package and putting them in the directory.

gentlegiantJGC avatar Jun 02 '25 13:06 gentlegiantJGC

The correct way to include licence files is to list them with this https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license-files

gentlegiantJGC avatar Sep 11 '25 09:09 gentlegiantJGC