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

Review and revise PyPI page for Kedro #2952

Closed
stichbury opened this issue Aug 21, 2023 · 6 comments
Closed

Review and revise PyPI page for Kedro #2952

stichbury opened this issue Aug 21, 2023 · 6 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed

Comments

@stichbury
Copy link
Contributor

Description

https://pypi.org/project/kedro/ is looking a bit dated now we've updated our contribution guide and set up awesome-kedro. There's also a missing graphic and the badges don't work :-0

As a matter of priority, let's review the page and revise it to fix any issues with it.

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Aug 21, 2023
@astrojuanlu
Copy link
Member

The contents of the page are derived from README.md:

readme = {file = "README.md", content-type = "text/markdown"}

@stichbury
Copy link
Contributor Author

Interesting, so if we modify a README (like I did recently) and we don't do an immediate release, they get out of step as they've done here.

I wonder with the graphic though because that hasn't changed. Looking at the source on PyPI it seems to have taken the graphic link we provide in readme and built a new link, which is returning an invalid type error. I wonder if we should stick to text given the content-type specifier and remove the Viz graphic from the README?

<p><img src="https://pypi-camo.global.ssl.fastly.net/3ccc99c7fcb6c3725961907efaee199655272150/68747470733a2f2f6769746875622e636f6d2f6b6564726f2d6f72672f6b6564726f2d76697a2f626c6f622f6d61696e2f2e6769746875622f696d672f62616e6e65722e706e67" alt="Kedro-Viz Pipeline Visualisation"></a></em></p>

@astrojuanlu
Copy link
Member

I'm not 100 % sure but for the case of images, we'll probably have to change

![Kedro-Viz Pipeline Visualisation](https://github.com/kedro-org/kedro-viz/blob/main/.github/img/banner.png)

with the corresponding "raw" URLs, in this case https://raw.githubusercontent.com/kedro-org/kedro-viz/main/.github/img/banner.png

@astrojuanlu astrojuanlu added the Issue: Bug Report 🐞 Bug that needs to be fixed label Aug 22, 2023
@astrojuanlu
Copy link
Member

Labeling this as a bug, we shouldn't have a broken PyPI page

@stichbury
Copy link
Contributor Author

I vote to remove the pipeline visualisation since that's a Viz feature and we link to viz anyway; the graphic is on that README where it should be. We need to fix that in the https://pypi.org/project/kedro-viz/ page so let's do as you suggest and use the raw URL to see if works. I'm start on a PR for all this.

@stichbury
Copy link
Contributor Author

Fixed in two merged PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed
Projects
Archived in project
Development

No branches or pull requests

2 participants