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.

Sign up for GitHub

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

Jump to bottom

InvalidDistribution: Metadata is missing required fields: Name, Version. #1446

Open
impredicative opened this issue Dec 16, 2024 · 4 comments
Open

InvalidDistribution: Metadata is missing required fields: Name, Version. #1446

impredicative opened this issue Dec 16, 2024 · 4 comments

Comments

@impredicative
Copy link

Steps to Reproduce

I am unable to publish to PyPI. This was working fine for me with an older version of rye. For what it's worth, here is my pyproject.toml.

Expected Result

Obviously I should be able to publish to PyPI.

Actual Result

I get the error:

Uploading distributions to https://upload.pypi.org/legacy/
ERROR    InvalidDistribution: Metadata is missing required fields: Name, Version.                                                                                                                   
         Make sure the distribution includes the files where those fields are specified, and is using a supported Metadata-Version: 1.0, 1.1, 1.2, 2.0, 2.1, 2.2, 2.3.                              
error: failed to publish files

I do have name and version defined in my pyproject.toml (see Steps).

Version Info

rye 0.43.0
commit: unknown (d67cac134 2024-12-09)
platform: linux (aarch64)
self-python: cpython@3.12.8
symlink support: true
uv enabled: true

Stacktrace

No response
@PushUpek
Copy link
Contributor

I am experiencing the same issue.

Hatch (starting from version 1.27) builds packages with the new Metadata-Version: 2.4.

In the PKG-INFO file, the metadata includes:

Metadata-Version: 2.4

However, Rye uses twine==5.1.1, which does not support Metadata-Version 2.4.

If you update your pyproject.toml to the following:

[build-system]
requires = ["hatchling==1.26.3", "hatch-vcs"]
build-backend = "hatchling.build"

you should be able to build and publish the package successfully.

@impredicative
Copy link
Author

impredicative commented Dec 16, 2024 •
edited
Loading

That's an effective workaround. To recap, essentially, in my pyproject.toml, I applied the following diff:

 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling==1.26.3"]  # Without a version spec, hatchling==1.27.0 is used which fails to publish. Ref: https://github.com/astral-sh/rye/issues/1446#issuecomment-2545154562

As for hatch-vcs, I didn't need to list it.

I will leave this issue open for the rye maintainers to still fix as the current solution is just a workaround.

@drammock drammock mentioned this issue Dec 17, 2024
Merged
7 tasks
@sswatson
Copy link

I had the same problem, and this solution worked for me too.

I believe this problem could be fixed by bumping the version of twine in bootstrap.rs again, but pinning the twine version used by Rye internally while leaving the hatchling version in the user project unrestricted seems like it's going to be an ongoing footgun.

@Neeky
Copy link

Neeky commented Dec 31, 2024

python3 -m pip install twine --upgrade can fix this problem .

davep added a commit to davep/braindrop that referenced this issue Dec 31, 2024
@davep
🔧 Work around astral-sh/rye#1446
86b093f
hf-kklein pushed a commit to Hochfrequenz/edi_energy_scraper that referenced this issue Jan 1, 2025
fix(ci): pin hatchling to 1.26.3
cc38ec0 
astral-sh/rye#1446 (comment)

fixes
test_packaging: install_deps> python -I -m pip install './.[test_packaging]'
test_packaging: freeze> python -m pip freeze --all
test_packaging: aiodns==3.2.0,aiohappyeyeballs==2.4.4,aiohttp==3.11.11,aiohttp-requests==0.2.4,aiosignal==1.3.2,attrs==24.3.0,beautifulsoup4==4.12.3,Brotli==1.1.0,build==1.2.2.post1,certifi==2024.12.14,cffi==1.17.1,charset-normalizer==3.4.1,coworker==2.0.1,cryptography==44.0.0,docutils==0.21.2,edi_energy_scraper @ file:///home/runner/work/edi_energy_scraper/edi_energy_scraper,efoli==1.4.0,frozenlist==1.5.0,idna==3.10,importlib_metadata==8.5.0,jaraco.classes==3.4.0,jaraco.context==6.0.1,jaraco.functools==4.1.0,jeepney==0.8.0,keyring==25.6.0,markdown-it-py==3.0.0,mdurl==0.1.2,more-itertools==10.5.0,multidict==6.1.0,nh3==0.2.20,packaging==24.2,pip==24.3.1,pkginfo==1.10.0,propcache==0.2.1,pycares==4.5.0,pycparser==2.22,Pygments==2.18.0,pypdf==5.1.0,pyproject_hooks==1.2.0,pytz==2024.2,readme_renderer==44.0,requests==2.32.3,requests-toolbelt==1.0.0,rfc3986==2.0.0,rich==13.9.4,SecretStorage==3.3.3,soupsieve==2.6,twine==5.1.1,urllib3==2.3.0,yarl==1.18.3,zipp==3.21.0
test_packaging: commands[0]> python -m build
* Creating isolated environment: venv+pip...
* Installing packages in isolated environment:
  - hatch-fancy-pypi-readme
  - hatch-vcs
  - hatchling>=1.8.0
* Getting build dependencies for sdist...
* Building sdist...
/tmp/build-env-k7f83_yi/lib/python3.13/site-packages/setuptools_scm/git.py:167: UserWarning: "/home/runner/work/edi_energy_scraper/edi_energy_scraper" is shallow and may cause errors
  warnings.warn(f'"{wd.path}" is shallow and may cause errors')
* Building wheel from sdist
* Creating isolated environment: venv+pip...
* Installing packages in isolated environment:
  - hatch-fancy-pypi-readme
  - hatch-vcs
  - hatchling>=1.8.0
* Getting build dependencies for wheel...
* Building wheel...
Successfully built edi_energy_scraper-0.1.dev1+g0a0788a.tar.gz and edi_energy_scraper-0.1.dev1+g0a0788a-py3-none-any.whl
test_packaging: commands[1]> twine check 'dist/*'
Checking dist/edi_energy_scraper-0.1.dev1+g0a0788a-py3-none-any.whl: ERROR    InvalidDistribution: Metadata is missing required fields: Name,
         Version.
         Make sure the distribution includes the files where those fields are
         specified, and is using a supported Metadata-Version: 1.0, 1.1, 1.2,
         2.0, 2.1, 2.2, 2.3.
test_packaging: exit 1 (0.31 seconds) /home/runner/work/edi_energy_scraper/edi_energy_scraper> twine check 'dist/*' pid=2025
  test_packaging: FAIL code 1 (16.54=setup[12.46]+cmd[3.77,0.31] seconds)
  evaluation failed :( (16.61 seconds)
@hf-kklein hf-kklein mentioned this issue Jan 1, 2025
Merged
hf-kklein added a commit to Hochfrequenz/edi_energy_scraper that referenced this issue Jan 1, 2025
@hf-kklein
fix(ci): pin hatchling to 1.26.3 (#256)
ac4affd 
astral-sh/rye#1446 (comment)

fixes
test_packaging: install_deps> python -I -m pip install './.[test_packaging]'
test_packaging: freeze> python -m pip freeze --all
test_packaging: aiodns==3.2.0,aiohappyeyeballs==2.4.4,aiohttp==3.11.11,aiohttp-requests==0.2.4,aiosignal==1.3.2,attrs==24.3.0,beautifulsoup4==4.12.3,Brotli==1.1.0,build==1.2.2.post1,certifi==2024.12.14,cffi==1.17.1,charset-normalizer==3.4.1,coworker==2.0.1,cryptography==44.0.0,docutils==0.21.2,edi_energy_scraper @ file:///home/runner/work/edi_energy_scraper/edi_energy_scraper,efoli==1.4.0,frozenlist==1.5.0,idna==3.10,importlib_metadata==8.5.0,jaraco.classes==3.4.0,jaraco.context==6.0.1,jaraco.functools==4.1.0,jeepney==0.8.0,keyring==25.6.0,markdown-it-py==3.0.0,mdurl==0.1.2,more-itertools==10.5.0,multidict==6.1.0,nh3==0.2.20,packaging==24.2,pip==24.3.1,pkginfo==1.10.0,propcache==0.2.1,pycares==4.5.0,pycparser==2.22,Pygments==2.18.0,pypdf==5.1.0,pyproject_hooks==1.2.0,pytz==2024.2,readme_renderer==44.0,requests==2.32.3,requests-toolbelt==1.0.0,rfc3986==2.0.0,rich==13.9.4,SecretStorage==3.3.3,soupsieve==2.6,twine==5.1.1,urllib3==2.3.0,yarl==1.18.3,zipp==3.21.0
test_packaging: commands[0]> python -m build
* Creating isolated environment: venv+pip...
* Installing packages in isolated environment:
  - hatch-fancy-pypi-readme
  - hatch-vcs
  - hatchling>=1.8.0
* Getting build dependencies for sdist...
* Building sdist...
/tmp/build-env-k7f83_yi/lib/python3.13/site-packages/setuptools_scm/git.py:167: UserWarning: "/home/runner/work/edi_energy_scraper/edi_energy_scraper" is shallow and may cause errors
  warnings.warn(f'"{wd.path}" is shallow and may cause errors')
* Building wheel from sdist
* Creating isolated environment: venv+pip...
* Installing packages in isolated environment:
  - hatch-fancy-pypi-readme
  - hatch-vcs
  - hatchling>=1.8.0
* Getting build dependencies for wheel...
* Building wheel...
Successfully built edi_energy_scraper-0.1.dev1+g0a0788a.tar.gz and edi_energy_scraper-0.1.dev1+g0a0788a-py3-none-any.whl
test_packaging: commands[1]> twine check 'dist/*'
Checking dist/edi_energy_scraper-0.1.dev1+g0a0788a-py3-none-any.whl: ERROR    InvalidDistribution: Metadata is missing required fields: Name,
         Version.
         Make sure the distribution includes the files where those fields are
         specified, and is using a supported Metadata-Version: 1.0, 1.1, 1.2,
         2.0, 2.1, 2.2, 2.3.
test_packaging: exit 1 (0.31 seconds) /home/runner/work/edi_energy_scraper/edi_energy_scraper> twine check 'dist/*' pid=2025
  test_packaging: FAIL code 1 (16.54=setup[12.46]+cmd[3.77,0.31] seconds)
  evaluation failed :( (16.61 seconds)

Co-authored-by: Konstantin <konstantin.klein+github@hochfrequenz.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@impredicative @PushUpek @sswatson @Neeky