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

[Tidy] Improve appearance of README on PyPI #969

Merged
merged 7 commits into from
Jan 29, 2025

Conversation

manuelkonrad
Copy link
Contributor

@manuelkonrad manuelkonrad commented Jan 26, 2025

Description

  • In README.md, changed default logo to the light mode logo which hopefully fixes the appearance on PyPI.
  • Added logo to Vizro-AI README.
  • Since GIFs are also broken on PyPI (although I saw working examples when markdown syntax is used), I placed them in a picture element. Not sure if it helps. If not, you can provide an alternative PNG in the img element (will serve as fallback). Added fallback PNGs.
  • Resolves Revise the graphics used in README for vizro-ai and vizro-core so they render better in PyPI #380

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@github-actions github-actions bot added the Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package label Jan 26, 2025
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

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

Hey @manuelkonrad - thanks for taking on another issue! 🚀
This looks good to me. I have a few minor comments, but it's ready to merge from my side 👍 I'll leave the final review to @stichbury or @Joseph-Perkins .

vizro-ai/README.md Outdated Show resolved Hide resolved
vizro-ai/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

I don't know why, but I'm not seeing the GIF at the top of the page when I view the file with changes:

image

@huong-li-nguyen
Copy link
Contributor

I don't know why, but I'm not seeing the GIF at the top of the page when I view the file with changes:

Might be just a browser issue. Is this what you see when you click on this link? For me, it looks fine 👍

@stichbury
Copy link
Contributor

Is this what you see when you click on this link? For me, it looks fine 👍

That does look fine. I'm looking at the changed file in the PR though, and that doesn't: https://github.com/mckinsey/vizro/blob/ac400c876856f04bef519d29faf8b1eef857bb6c/README.md

Could be just because it's on a fork I guess.

@manuelkonrad
Copy link
Contributor Author

As suggested by @huong-li-nguyen, I also changed the image reference in vizro-ai/docs/index.md and removed the redundant gif. Therefore, the docs will have a direct link to the gif hosted on github.

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution @manuelkonrad!

@huong-li-nguyen huong-li-nguyen merged commit 0bad37a into mckinsey:main Jan 29, 2025
42 checks passed
@manuelkonrad manuelkonrad deleted the tidy/improve-pypi-logos branch January 29, 2025 18:48
@antonymilne
Copy link
Contributor

antonymilne commented Feb 3, 2025

Ahhh this issue has bugged me for ages! I'm so pleased to see it resolved. Thank you very much for your contribution @manuelkonrad.

@manuelkonrad
Copy link
Contributor Author

Ahhh this issue has bugged me for ages! I'm so pleased to see it resolved. Thank you very much for your contribution @manuelkonrad.

@antonymilne Let's see after the next release whether the PyPI page actually looks better (or you upload to Test PyPI in the meantime).

BTW, really amazing how fast you iterate on PRs!

@huong-li-nguyen
Copy link
Contributor

@antonymilne Let's see after the next release whether the PyPI page actually looks better (or you upload to Test PyPI in the meantime).

We just released - it looks great! 🚀 https://pypi.org/project/vizro/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Vizro-AI 🤖 Issue/PR that addresses Vizro-AI package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revise the graphics used in README for vizro-ai and vizro-core so they render better in PyPI
4 participants