[GSK-2760] Fix README images display in PyPI

[vjern]

Description

All images (and static resources from outside of the giskard root folder) are broken on the package's PyPI page.

The readme folder is actually not added to either the source distribution (.tar.gz file) or the package's wheel and thus nothing in there gets uploaded, which is most likely why PyPI is unable to display anything.

Reason is readme is not considered a package by the build system.

Available fixes

There a few approaches to solve this that we can try:

• Pull the images directly from the main banch using raw.githubusercontent.com
  • Pros: Used by other packages, low maintenance (just be careful about changing the image files, may be better to just add new files rather than replacing / deleting them)
  • Cons: Releases will be using the main branch's images rather than the images associated to the release's commit
• Add the images to the sdist (Move them to the giskard root folder)
• Add readme to the sdist somehow

I chose to go with the first one for simplicity's sake.

Related Issue

Type of Change

• 📚 Examples / docs / tutorials / dependencies update
• 🔧 Bug fix (non-breaking change which fixes an issue)
• 🥂 Improvement (non-breaking change which improves an existing feature)
• 🚀 New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to change)
• 🔐 Security fix

Checklist

• I've read the CODE_OF_CONDUCT.md document.
• I've read the CONTRIBUTING.md guide.
• I've updated the code style using make codestyle.
• I've written tests for all new methods and classes that I created.
• I've written the docstring in Google format for all the methods and classes that I used.

[linear]

GSK-2760 Broken images on a PyPi page

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud