Skip to content

Fix PyPI README rendering metadata #1341

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

Closed
marko1olo wants to merge 1 commit into from
Closed

Fix PyPI README rendering metadata #1341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,6 @@ Copyright 2017 The OpenFermion Developers.
<div align="center">
<a href="https://quantumai.google">
<img width="15%" alt="Google Quantum AI"
src="https://raw.githubusercontent.com/quantumlib/OpenFermion/refs/heads/main/docs/images/quantum-ai-vertical.svg">
src="https://raw.githubusercontent.com/quantumlib/OpenFermion/main/docs/images/quantum-ai-vertical.svg">

@mhucka mhucka Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is not necessary; the original URL works, as can be seen from the fact that the same URL pattern works for the Cirq project on pypi.org.

</a>
</div>
1 change: 1 addition & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
maintainer_email='quantum-oss-maintainers@google.com',
description=('The electronic structure package for quantum computers.'),
long_description=long_description,
long_description_content_type='text/markdown',

@gemini-code-assist gemini-code-assist Bot Jun 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Setting long_description_content_type to 'text/markdown' causes the prepended RST-style header on lines 23-25 (long_description = '===========\n' + 'OpenFermion\n' + '===========\n\n') to be parsed as a Markdown H1 header. Since README.md already contains a # OpenFermion header, this results in a duplicate title rendering on PyPI.

To fix this, please update lines 23-25 to read the file directly without prepending the redundant header:

with open('README.md', 'r', encoding='utf-8') as readme:
    long_description = readme.read()

python_requires='>=3.10.0',
install_requires=requirements,
extras_require={'resources': resource_requirements},
Expand Down
Loading