google-auth-library-python-oauthlib icon indicating copy to clipboard operation
google-auth-library-python-oauthlib copied to clipboard

fix: do not include docs/conf.py & scripts in wheel

Open mgorny opened this issue 1 year ago • 7 comments

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • [ ] Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • [x] Ensure the tests and linter pass
  • [x] Code coverage does not decrease (if any source code was changed)
  • [x] Appropriate docs were updated (if necessary)

mgorny avatar Jan 08 '24 14:01 mgorny

@mgorny Thank you for this change. The contents look correct. It seems the lint check is failing, so please run nox -s blacken to fix the formatting issues, and push those changes.

clundin25 avatar Jan 08 '24 15:01 clundin25

adding @dandhlee as reviewer for the docs pipeline

parthea avatar Jan 08 '24 15:01 parthea

Sorry about that, should be fixed now.

mgorny avatar Jan 08 '24 16:01 mgorny

Fine to excludedocs directory for setup, any reason why it's marked as a fix? Have you run into any issues?

dandhlee avatar Jan 08 '24 19:01 dandhlee

Yes. Since the files are included in wheels, they are installed inside site-packages. This triggers QA checks in Gentoo and causes the build process to error out due to installing forbidden/collision-prone top-level packages.

mgorny avatar Jan 08 '24 20:01 mgorny

Just curious, where/how are you seeing them in site-packages?

Could you elaborate a bit more on how your tool is installing the top level packages?

This also sounds like it's a problem unique to the tool, so I'd mark it as a chore or build prefix rather than fix, unless this is fixing a bug directly related to this repository content.

dandhlee avatar Jan 09 '24 06:01 dandhlee

To reproduce:

git clone https://github.com/googleapis/google-auth-library-python-oauthlib/
cd google-auth-library-python-oauthlib
python -m venv .venv
. .venv/bin/activate
pip install .
ls .venv/lib/python3.12/site-packages/

You're going to notice that there are docs and scripts directories there.

mgorny avatar Jan 09 '24 09:01 mgorny

Ping.

mgorny avatar Jul 09 '24 01:07 mgorny

Thank you!

mgorny avatar Jul 09 '24 09:07 mgorny