Adding python badge displaying the versions tested in the CI #200
Conversation
agoscinski
force-pushed
the
adding-python-badge
branch
2 times, most recently
from
630a170 to
135e8f8
Compare
PicoCentauri
left a comment
PicoCentauri
left a comment
There was a problem hiding this comment.
Good and important additions for the pyproject.toml. I think the banner is a bit superfluous (see my comment).
README.rst
Outdated
| .. |python| image:: https://img.shields.io/badge/documentation-latest-sucess | ||
| :alt: Python | ||
| :target: https://scikit-matter.readthedocs.io |
There was a problem hiding this comment.
I think this is duplicated and can be removed.
README.rst
Outdated
| .. |python| image:: https://img.shields.io/badge/python-v3.8,_v3.9,_v3.10,_v3.11-blue.svg | ||
| :alt: Tested Python versions in CI | ||
| :target: (https://github.com/scikit-learn-contrib/scikit-matter/\ | ||
| blob/main/.github/workflows/tests.yml) |
There was a problem hiding this comment.
We had this idea also for equistore and rascaline. But, we concluded that a version banner does not add much additional information and is cluttering the README. Especially because on PYPI the versions will now be shown in the Meta section (see i.e. scikit-learn) based on your additions below.
There was a problem hiding this comment.
I would say it is not exactly the same information as in the Meta section on pypi. "Python (>= 3.8)" does not specify which version we test on in the CI. I am not sure if the link is very meaningful. Maybe we can combine it with the test badge that we test on these versions. I will look into this.
|
I added a section talking about on what exact platforms we do CI tests. I think that is useful for a user to know. The meta information is more about what we expect it supposed to work on. Also I just wrote a sentence because a table seemed a bit too much. I would like it more if this this is somehow integrated in our test badge, but I found no way to do it. I think it is good enough. Also added badge for the doi of the paper. |
.github/workflows/tests.yml
Outdated
| python-version: '3.10' | ||
| - os: windows-latest | ||
| python-version: '3.10' | ||
| - os: ubuntu-2204 |
There was a problem hiding this comment.
I like more explicit versions so I changed to ubuntu-2204
* CI tests now test python 3.7 and 3.11 for all OS * in CI tests mark explicitly ubuntu version 22.04 * update package classifiers with python version and OS * add section into README that specifies on which OS and python version we test
agoscinski
force-pushed
the
adding-python-badge
branch
from
fae1381 to
1b56b52
Compare
📚 Documentation preview 📚: https://scikit-matter--200.org.readthedocs.build/en/200/