Working example for setuptools.file_finders?

[karolyi]

Hello,

I have a project where I need to exclude files from under src/ (tests) and I bumped into the file_finders option: https://setuptools-scm.readthedocs.io/en/latest/usage/#file-finders-hook-makes-most-of-manifestin-unnecessary

This is all nice and dandy but I couldn't get it to work within a pyproject.toml, and I couldn't find any examples for it.

It would be highly appreciated if someone could create more documentation about it with actual working examples, because I've been searching for a solution for half a day now, and I'm not even a rookie in python.

If I can't get it to work, I have no idea how other people will be able to.

[RonnyPfannschmidt]

File finders are not configured

Excludes in setuptools are done via manifest

[karolyi]

I have two flavors of my package, one includes an extra directory and pulls extra dependencies, and the other doesn't.

Does that mean that I shouldn't even try using file_finders? I.e., the documentation is obsolete/outdated?

I found some file_finders configuration in here, by searching through every possible places: https://github.com/pypa/setuptools-scm/blob/main/pyproject.toml

Currently trying to figure out how this works because so far I couldn't make it call my created function.

[karolyi]

Oh, well. The phrasing of the above linked documentation isn't pretty straightforward, for me at least.

It states what you've replied but in a roundabout way. Maybe if it could be rephrased to something like "this package pulls in all the SCM-tracked files, configure MANIFEST.in if you need to exclude specific ones".

My first couple reads of it made me think that I can use a file_finders hook to provide my own logic for listing the included files.

[RonnyPfannschmidt]

the docs have been updated with more details on the file finder