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

Feature/#507 separate package long desc with readme #1284

Merged

Conversation

trgiangdo
Copy link
Member

Resolves #507

In this PR:

  • Add a "package_desc.md" file for each taipy package and use that instead of "README.md" on "setup.py"
  • Remove redundant "CONTRIBUTING.md" files in subpackages
  • Minor updates on "README.md" files and "INSTALLATION.md" files

@trgiangdo trgiangdo added 📈 Improvement Improvement of a feature. 🖧 Devops Operations, monitoring, maintenance, deployment, packaging 📄 Documentation Internal or public documentation labels May 14, 2024
@trgiangdo trgiangdo self-assigned this May 14, 2024
Copy link
Contributor

github-actions bot commented May 14, 2024

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
18436 16129 87% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
taipy/config/setup.py 0% 🟢
taipy/core/setup.py 0% 🟢
taipy/gui/setup.py 0% 🟢
taipy/rest/setup.py 0% 🟢
TOTAL 0% 🟢

updated for commit: 404685d by action🐍

Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

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

I would take the opportunity to:

  • Remove all sub-package CODE_OF_CONDUCT.md
  • Merge all sub-package INSTALLATION.md into README.md
  • Remove for all sub-packages, the 3 sections (running the tests, contributing, and code of conduct) of the package_desc.md

package_desc.md Outdated Show resolved Hide resolved
package_desc.md Outdated Show resolved Hide resolved
package_desc.md Outdated Show resolved Hide resolved
package_desc.md Outdated Show resolved Hide resolved
package_desc.md Outdated Show resolved Hide resolved
taipy/config/README.md Outdated Show resolved Hide resolved
taipy/config/README.md Outdated Show resolved Hide resolved
taipy/config/INSTALLATION.md Outdated Show resolved Hide resolved
taipy/config/package_desc.md Outdated Show resolved Hide resolved
taipy/core/package_desc.md Outdated Show resolved Hide resolved
@trgiangdo
Copy link
Member Author

Since each sub taipy folder is still a standalone package, I think it's a good practice to have its own "CODE_OF_CONDUCT.md", even if it's duplicated, we never change it anyway.

For the "INSTALLATION.md", I think we can keep it but no strong opinion. Keep in mind that the content of the installation instruction can be added to the "package_desc.md" as a link to the "INSTALLATION.md" file, it must be a Github link, which is possible.

I would keep the contributing and code of conduct sections in Pypi description since it's quite useful information and link directly to our doc anyway

package_desc.md Outdated
Comment on lines 54 to 69
## Contributing

Writing code isn’t the only way to contribute to Taipy. You can also:
- help us stay on top of new and old issues
- develop tutorials, presentations, and other educational materials
- maintain and improve [our website](https://www.taipy.io) and [documentation](https://docs.taipy.io/en/latest/)
- review pull requests
- help with outreach and onboard new contributors

For more information about the ways you can contribute to Taipy, visit our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).
If you’re unsure where to start or how your skills fit in, reach out on Discord. You can also ask on
GitHub, by opening a new issue or leaving a comment on a relevant issue that is already open.

If you are new to contributing to open source projects, [this guide](https://opensource.guide/how-to-contribute/)
helps explain why, what, and how to successfully get involved.
Copy link
Member

Choose a reason for hiding this comment

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

I agree; I think Pypi users want a description, information on license, security and maintenance, and a link to the documentation. Since you can't contribute on Taipy, a contribution section doesn't make much sense.

setup.py Outdated Show resolved Hide resolved
taipy/rest/package_desc.md Show resolved Hide resolved
@florian-vuillemot
Copy link
Member

Having just one "CODE_OF_CONDUCT.md" is enough, IMHO, because, as you said, it's the same everywhere, and it is not helpful information on Pypi.
I completely agree with you about the contribution file. Having a "CONTRIBUTING.md" in each folder makes a lot of sense, with the CONTRIBUTING.md at the root of the repository acting as a proxy for the others. Nevertheless, I wouldn't put this file on Pypi because it doesn't bring any value to the user using the package.

jrobinAV
jrobinAV previously approved these changes May 20, 2024
@trgiangdo trgiangdo merged commit eb1a76c into develop Jun 3, 2024
61 checks passed
@trgiangdo trgiangdo deleted the feature/#507-separate-package-long-desc-with-readme branch June 3, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖧 Devops Operations, monitoring, maintenance, deployment, packaging 📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stop using the README as long description in the various setup.py
3 participants