Feature/#507 separate package long desc with readme #1284
Conversation
trgiangdo
added
📈 Improvement
trgiangdo
requested review from
florian-vuillemot,
FabienLelaquais,
jrobinAV and
joaoandre-avaiga
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
| ## Running the tests | ||
|
|
||
| To run the tests on the package, you need to install the required development packages. | ||
| We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment | ||
| and install the development packages. | ||
|
|
||
| ```bash | ||
| pip install pipenv | ||
| pipenv install --dev | ||
| ``` | ||
|
|
||
| Then you can run *taipy-config* tests with the following command: | ||
|
|
||
| ```bash | ||
| pipenv run pytest tests/config | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Want to help build *Taipy Config*? Check out our | ||
| [Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/). | ||
|
|
||
| ## Code of conduct | ||
|
|
||
| Taipy is an open source project developed by the Taipy development team and a community of | ||
| [contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the | ||
| [Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance | ||
| on how to interact with others in a way that makes our community thrive. |
There was a problem hiding this comment.
Do we need the tests, contributing and code of conduct sections in Pypi?
There was a problem hiding this comment.
A lot of other packages are also showing a link to their code_of_conduct page and contribution page. I think it's a common practice
There was a problem hiding this comment.
I personally don't see the purpose. @FabienLelaquais @Avaiga/r-d ? What do you think?
Co-authored-by: Jean-Robin <jeanrobin.medori@avaiga.com>
|
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 |
| ## 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. |
There was a problem hiding this comment.
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.
| ```bash | ||
| pip install gunicorn | ||
|
|
||
| gunicorn myapi.wsgi:app |
There was a problem hiding this comment.
I thought Taipy core had problems with Gunicorn?
There was a problem hiding this comment.
I don't know. It's still in the rest/README.md
|
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. |
Resolves #507
In this PR: