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

DOC: Add different GitHub badges to the `README.rst` file. #1425

Merged
merged 1 commit into from Mar 7, 2018

Conversation

Projects
None yet
3 participants
@jhlegarreta
Contributor

jhlegarreta commented Feb 11, 2018

Add GitHub badges to make DIPY's GitHub home page more informative.
Specificically, add the

  • Release badge
  • Python (PyPI) badge
  • License badge
@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Feb 11, 2018

Not sure whether the release number is being displayed correctly. Check

.. image:: https://img.shields.io/github/release/qubyte/rubidium.svg
  :target: https://github.com/nipy/dipy/releases/latest

in
https://livesphinx.herokuapp.com/

Related information
https://help.github.com/articles/linking-to-releases/

I set the order of the badges to what I thought was sensible. Subject to comments.

Also, IMHO out home page would be more appealing if we added the DIPY logo (?), like in:
https://github.com/keras-team/keras

@codecov-io

This comment has been minimized.

codecov-io commented Feb 11, 2018

Codecov Report

Merging #1425 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #1425      +/-   ##
=========================================
- Coverage   87.42%   87.4%   -0.03%     
=========================================
  Files         239     239              
  Lines       30579   30579              
  Branches     3291    3291              
=========================================
- Hits        26735   26727       -8     
- Misses       3075    3081       +6     
- Partials      769     771       +2
Impacted Files Coverage Δ
dipy/reconst/forecast.py 90.15% <0%> (-2.08%) ⬇️
dipy/data/fetcher.py 45.34% <0%> (-1.17%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 783dc06...a957ab0. Read the comment docs.

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:AddGitHubBadges branch from c973808 to 299830c Mar 5, 2018

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Mar 5, 2018

299830c was rebased on master.

@skoudoro

I think, you can add some conda badges like platform or download.

I agree with you for adding DIPY Logo

README.rst Outdated
@@ -8,6 +8,15 @@
.. image:: https://codecov.io/gh/nipy/dipy/branch/master/graph/badge.svg
:target: https://codecov.io/gh/nipy/dipy
.. image:: https://img.shields.io/github/release/qubyte/rubidium.svg
:target: https://github.com/nipy/dipy/releases/latest

This comment has been minimized.

@skoudoro

skoudoro Mar 6, 2018

Member

Since it does not work, we can replace it by:

.. image:: https://badge.fury.io/py/dipy.svg
  :target: https://badge.fury.io/py/dipy

This comment has been minimized.

@jhlegarreta

jhlegarreta Mar 6, 2018

Contributor

It was not showing the right release because it was pointing to another repo (my bad!), but this is still not working:
https://img.shields.io/github/release/nipy/dipy.svg
API call:
https://api.github.com/repos/nipy/dipy/releases/latest
Compare the API call answer to
https://api.github.com/repos/insightsoftwareconsortium/itk/releases/latest

In any case, for now I ignore what's wrong, and I'm leaving the PyPI version (using the "official" or more common badge server Serge):

.. image:: https://img.shields.io/pypi/v/dipy.svg
  :target: https://pypi.python.org/pypi/dipy
README.rst Outdated
:target: https://github.com/nipy/dipy/releases/latest
.. image:: https://img.shields.io/pypi/pyversions/Django.svg
:target: https://pypi.python.org/pypi/dipy

This comment has been minimized.

@skoudoro

skoudoro Mar 6, 2018

Member

is it really necessary to show python version? IMHO, you can remove it

This comment has been minimized.

@jhlegarreta

jhlegarreta Mar 6, 2018

Contributor

Again, my fault: it was showing Django's. I think knowing which python versions are supported is worthwhile, but looks like that is only possible for PyPI, and it is not working wither for DIPY, so I'm removing it.

README.rst Outdated
:target: https://pypi.python.org/pypi/dipy
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://github.com/nipy/dipy/blob/master/LICENSE

This comment has been minimized.

@skoudoro

skoudoro Mar 6, 2018

Member

good, thanks!

Jon Haitz Legarreta
DOC: Add different GitHub badges to the `README.rst` file.
Add GitHub badges to make DIPY's GitHub home page more informative.
Specificically, add the
- PyPI badge
- Conda platforms
- Conda downloads
- License badge

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:AddGitHubBadges branch from 299830c to a957ab0 Mar 6, 2018

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Mar 6, 2018

Added the platform and downloads Conda badges as suggested !

As for the logo, please let me know where I can find a high resolution version to add it. Thanks.

@skoudoro

This comment has been minimized.

Member

skoudoro commented Mar 6, 2018

Currently, you can use:

But we definitively have to add a better logo in this repo.

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Mar 7, 2018

Thanks @skoudoro. Banner added in PR #1451.

This one can thus be merged.

@skoudoro

This comment has been minimized.

Member

skoudoro commented Mar 7, 2018

ok, Thanks @jhlegarreta, merging!

@skoudoro skoudoro merged commit 8e0a212 into nipy:master Mar 7, 2018

2 of 3 checks passed

codecov/project 87.4% (-0.03%) compared to 783dc06
Details
codecov/patch Coverage not affected when comparing 783dc06...a957ab0
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

ShreyasFadnavis pushed a commit to ShreyasFadnavis/dipy that referenced this pull request Sep 20, 2018

Merge pull request nipy#1425 from jhlegarreta/AddGitHubBadges
DOC: Add different GitHub badges to the `README.rst` file.

@jhlegarreta jhlegarreta deleted the jhlegarreta:AddGitHubBadges branch Oct 10, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment