Avaiga / taipy

Turns Data and AI algorithms into production-ready web applications in no time.
https://www.taipy.io
Apache License 2.0
10.94k stars 775 forks source link

Stop using the README as long description in the various setup.py #507

Closed jrobinAV closed 3 months ago

jrobinAV commented 9 months ago

In all the setup.py files (config, gui, core, rest, taipy, templates), the long_description is populated with the README.md content. This is NOT a good practice since the long description represents a description of the package built. It is used in Pypi to describe the package. The readme is also exposed as the landing page of the repo and used as instructions on how to use the code base. These have different purposes and different lifecycles. The content should be different.

The general idea is to split the use cases:

github-actions[bot] commented 3 months ago

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

trgiangdo commented 3 months ago

This issue is under review