Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove README from pypi package #2697

Closed
AlJohri opened this issue Mar 2, 2024 · 0 comments · Fixed by #2698
Closed

Remove README from pypi package #2697

AlJohri opened this issue Mar 2, 2024 · 0 comments · Fixed by #2698
Labels
bug Something isn't working

Comments

@AlJohri
Copy link
Contributor

AlJohri commented Mar 2, 2024

Describe the bug

The internal build system at Amazon is failing on awswrangler because the package contains the README.md and it is being deposited at the root of the site-packages folder.

Here is a sample error message:

brazil-path: PathGenerationException: com.amazon.brazil.util.farmbuilder.SymlinkFarmBuilder$SymlinkFarmConflictException: Symlink conflict exception at lib/python3.10/site-packages/README.md between symlink to /opt/brazil-pkg-cache/packages/Python-requests-aws4auth/Python-requests-aws4auth-1.x.490647.0/AL2_x86_64/DEV.STD.PTHREAD/build/lib/python3.10/site-packages/README.md and symlink to /opt/brazil-pkg-cache/packages/Python-awswrangler/Python-awswrangler-3.x.14978.0/AL2_x86_64/DEV.STD.PTHREAD/build/lib/python3.10/site-packages/README.md

How to Reproduce

You can see in the below commands that we create a fresh virtual environment, install awswrangler, and ls the contents of the site-packages folder. The README is for awswrangler and it appears other files are also being deposited top level.

❯ python3 -m venv .venv
❯ source .venv/bin/activate

❯ pip3 install awswrangler
...
Successfully installed awswrangler-3.6.0 boto3-1.34.54 botocore-1.34.54 jmespath-1.0.1 numpy-1.26.4 packaging-23.2 pandas-2.2.1 pyarrow-15.0.0 python-dateutil-2.9.0.post0 pytz-2024.1 s3transfer-0.10.0 six-1.16.0 typing-extensions-4.10.0 tzdata-2024.1 urllib3-1.26.18

❯ ls .venv/lib/python3.9/site-packages/
__pycache__                  numpy                                  README.md
_distutils_hack              numpy-1.26.4.dist-info                 s3transfer
awswrangler                  packaging                              s3transfer-0.10.0.dist-info
awswrangler-3.6.0.dist-info  packaging-23.2.dist-info               setuptools
boto3                        pandas                                 setuptools-58.1.0.dist-info
boto3-1.34.54.dist-info      pandas-2.2.1.dist-info                 six-1.16.0.dist-info
botocore                     pip                                    six.py
botocore-1.34.54.dist-info   pip-22.0.4.dist-info                   THIRD_PARTY.txt
dateutil                     pkg_resources                          typing_extensions-4.10.0.dist-info
distutils-precedence.pth     pyarrow                                typing_extensions.py
jmespath                     pyarrow-15.0.0.dist-info               tzdata
jmespath-1.0.1.dist-info     python_dateutil-2.9.0.post0.dist-info  tzdata-2024.1.dist-info
LICENSE.txt                  pytz                                   urllib3
NOTICE.txt                   pytz-2024.1.dist-info                  urllib3-1.26.18.dist-info

❯ head -n 1 .venv/lib/python3.9/site-packages/README.md
# AWS SDK for pandas (awswrangler)

This causes errors in the internal brazil build system because multiples packages are trying to write to the same path: lib/python3.10/site-packages/README.md.

Expected behavior

I expect all installed files to be scoped within the awswrangler and awswrangler-3.6.0.dist-info folders.

Your project

Internal

Screenshots

No response

OS

Amazon Linux 2

Python version

Python 3.10

AWS SDK for pandas version

3.6.0

Additional context

My internal alias is aljohri@. Please reach out if you have additional questions.

Similar change made 3 years ago in requests-awsauth package: tedder/requests-aws4auth@7adf104

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant