googleapis / google-auth-library-python-oauthlib

Apache License 2.0
186 stars 82 forks source link

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

Closed mgorny closed 4 months ago

mgorny commented 10 months ago

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:

clundin25 commented 10 months ago

@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.

parthea commented 10 months ago

adding @dandhlee as reviewer for the docs pipeline

mgorny commented 10 months ago

Sorry about that, should be fixed now.

dandhlee commented 10 months ago

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

mgorny commented 10 months ago

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.

dandhlee commented 10 months ago

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.

mgorny commented 10 months ago

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 commented 4 months ago

Ping.

mgorny commented 4 months ago

Thank you!