sigmavirus24 / github3.py

Hi, I'm a library for interacting with GItHub's REST API in a convenient and ergonomic way. I work on Python 3.6+.
https://github3.readthedocs.io
BSD 3-Clause "New" or "Revised" License
1.21k stars 404 forks source link

PyPI artifacts use invalid filenames #1145

Closed mgorny closed 1 year ago

mgorny commented 1 year ago

The PyPI artifacts for 4.0.0 violate the current version of sdist & wheel specifications by using dots in filenames:

github3.py-4.0.0.tar.gz
github3.py-4.0.0-py3-none-any.whl

However, the directory inside sdist seems to be named correctly:

$ tar -tf github3.py-4.0.0.tar.gz | head -n 1
github3_py-4.0.0/.pre-commit-config.yaml

FWIK hatchling does the correct thing so I guess the release pipeline is broken somewhere and renames the files to non-conformant filenames (but leaving the internal structure correct).

staticdev commented 1 year ago

@mgorny I used hatch to build and publish based on the config https://github.com/sigmavirus24/github3.py/pull/1144 If I don't do that, PyPI blocks the publish, so I do not have a clear solution for the problem for now.

mgorny commented 1 year ago

To be honest, I don't think there's a good solution right now, except for not using dot in project name. Good news is, to the best of my knowledge normalization treats ., _ and - as equivalent, so if you named the project e.g. github3-py this shouldn't break anything depending on it (but please don't take my word on it).

sigmavirus24 commented 1 year ago

To be honest, I don't think there's a good solution right now, except for not using dot in project name. Good news is, to the best of my knowledge normalization treats ., _ and - as equivalent, so if you named the project e.g. github3-py this shouldn't break anything depending on it (but please don't take my word on it).

I'll go back about 10 years in time and rename it right away

ofek commented 1 year ago

https://github.com/sigmavirus24/github3.py/pull/1142#issuecomment-1520707331

The nonconformant/"invalid" artifact names predate the latest release:

staticdev commented 1 year ago

@mgorny we have now 4.0.1

mgorny commented 1 year ago

Thanks. I'll test it tomorrow early morning, if that's ok.

mgorny commented 1 year ago

It works fine. Thanks again!