We have our first package through review - now we need a badge

ALL! THIS IS IMPORTANT!!!

we have our first package through review.
we now need a badge.

does anyone want to make something?
here is an example from ROS: GitHub - ropensci/piggyback: for using large(r) data files on GitHub it’s nice as it says “peer reviewed”. we can keep it simple.

Here is the issue:

THere are two badge RE Karthik:
The in review badge and
https://badges.ropensci.org/99v.svg

and reviewed badge:
https://badges.ropensci.org/289_status.svg

3 Likes

I don’t know how to make a badge from scratch, but I’ve used the templates from shields.io before.
ROS is awesome: https://badges.ropensci.org/
They even have a package to help with badges: https://ropensci.org/technotes/2019/05/21/rodev/

1 Like

@marskar i just posted on ROS slack about this!! i agree theirs is nice and i’m also only familiar with shields.io!! :slight_smile:

1 Like

ok update!! @noamross told me they use shields.io with
?logo=data:image/png;base64,... to create the logo. then they have a badge server that somehow automates what is on the badge as it goes through review!! pretty cool. for now i’ll see if anyone can help us create an initial badge!

1 Like

i can help make a tiny logo if i see the R one as well.

1 Like

I guess this is their badge, right?

https://badges.ropensci.org/264_status.svg

A Py instead of an R would maintain visual identity across sister projects, but I don’t wont prevent anyone from using their creativity and making something different :slight_smile:

1 Like

yes Agreed @ocefpaf !! i think it’s a great idea for us to maintain visual identity! we just need to make the badges. i haven’t had time this week!

This is the under review badge and the one you posted above is the accepted badge!!
https://badges.ropensci.org/99v.svg

1 Like

The hard part is to create the image for the Py (R here) and the circle under it. The text and colors are easily added thanks to http://shields.io. I’ll give it a try over the weekend and report back if I can make it.

1 Like

I do not like the font and the size here but here is a proof of concept for now:

The link is “https://img.shields.io/:PyOpenSci-Peer Reviewed-success.svg?logo=data:image/<insert base64 image here>

Everything after the : is what we can customize, text before, text after, and color (success is a color!) .

2 Likes

oooh i really like that @ocefpaf what don’t you like about the font? is it the serifs maybe on the Py part?
i love that success is a color :slight_smile: should we go ahead and use this for now?

Yep. It is the Py part that I don’t like. I’d like it to be closer the to R in the ROpenSci badge.
However, if you are OK with that, we can start using it. The shields link is,

https://img.shields.io/:PyOpenSci-Peer%20Reviewed-success.svg?logo=data:image/svg%2Bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8%2BPHN2ZyAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIgICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIiAgIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIgICB4bWxuczpzdmc9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgICB4bWxuczpzb2RpcG9kaT0iaHR0cDovL3NvZGlwb2RpLnNvdXJjZWZvcmdlLm5ldC9EVEQvc29kaXBvZGktMC5kdGQiICAgeG1sbnM6aW5rc2NhcGU9Imh0dHA6Ly93d3cuaW5rc2NhcGUub3JnL25hbWVzcGFjZXMvaW5rc2NhcGUiICAgdmVyc2lvbj0iMS4xIiAgIGlkPSJMYXllcl8xIiAgIHg9IjBweCIgICB5PSIwcHgiICAgdmlld0JveD0iMjcuMTkyOTgyMTk2ODA3ODYgMTAuMTk3MzY4NjIxODI2MTcyIDIwMy45NDczNTI4ODYxOTk5NSAyMTIuMTE2NjY4NzAxMTcxODgiICAgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgNzc1IDI3Ni43OyIgICBpbmtzY2FwZTp2ZXJzaW9uPSIwLjkxIHIxMzcyNSIgICBzb2RpcG9kaTpkb2NuYW1lPSJQeU9wZW5TY2kuc3ZnIj4gIDxtZXRhZGF0YSAgICAgaWQ9Im1ldGFkYXRhMTciPiAgICA8cmRmOlJERj4gICAgICA8Y2M6V29yayAgICAgICAgIHJkZjphYm91dD0iIj4gICAgICAgIDxkYzpmb3JtYXQ%2BaW1hZ2Uvc3ZnK3htbDwvZGM6Zm9ybWF0PiAgICAgICAgPGRjOnR5cGUgICAgICAgICAgIHJkZjpyZXNvdXJjZT0iaHR0cDovL3B1cmwub3JnL2RjL2RjbWl0eXBlL1N0aWxsSW1hZ2UiIC8%2BICAgICAgPC9jYzpXb3JrPiAgICA8L3JkZjpSREY%2BICA8L21ldGFkYXRhPiAgPGRlZnMgICAgIGlkPSJkZWZzMTUiIC8%2BICA8c29kaXBvZGk6bmFtZWR2aWV3ICAgICBwYWdlY29sb3I9IiNmZmZmZmYiICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIgICAgIGJvcmRlcm9wYWNpdHk9IjEiICAgICBvYmplY3R0b2xlcmFuY2U9IjEwIiAgICAgZ3JpZHRvbGVyYW5jZT0iMTAiICAgICBndWlkZXRvbGVyYW5jZT0iMTAiICAgICBpbmtzY2FwZTpwYWdlb3BhY2l0eT0iMCIgICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjIiICAgICBpbmtzY2FwZTp3aW5kb3ctd2lkdGg9IjM4NDAiICAgICBpbmtzY2FwZTp3aW5kb3ctaGVpZ2h0PSIyMDMxIiAgICAgaWQ9Im5hbWVkdmlldzEzIiAgICAgc2hvd2dyaWQ9ImZhbHNlIiAgICAgaW5rc2NhcGU6em9vbT0iNC40NTAzODEiICAgICBpbmtzY2FwZTpjeD0iLTMxLjQ0ODYzOSIgICAgIGlua3NjYXBlOmN5PSI5NS43MTYyNzEiICAgICBpbmtzY2FwZTp3aW5kb3cteD0iMCIgICAgIGlua3NjYXBlOndpbmRvdy15PSI1NSIgICAgIGlua3NjYXBlOndpbmRvdy1tYXhpbWl6ZWQ9IjEiICAgICBpbmtzY2FwZTpjdXJyZW50LWxheWVyPSJMYXllcl8xIiAvPiAgPHN0eWxlICAgICB0eXBlPSJ0ZXh0L2NzcyIgICAgIGlkPSJzdHlsZTMiPi5zdDB7ZmlsbDojMUExQTFBO308L3N0eWxlPiAgPHBhdGggICAgIGNsYXNzPSJzdDAiICAgICBkPSJtIDE3MS44NzkwOSwxMDYuMzY1NyAwLC04LjkwMDAwNCAtMjEuMywxOS41MDAwMDQgMjEuMywyMC40IDAsLTguOSBjIDIwLjMsMCAzMi40MDAwMSwxNy42IDMyLjQwMDAxLDM1LjUgMCwxNy45IC0xMi41LDM2LjEgLTMyLjQwMDAxLDM2LjEgLTIxLjU5OTk5LDAgLTMyLjM5OTk5LC0xOC4yIC0zMi4zOTk5OSwtMzYuMSBsIC0yNS4yMDAwMSwwIGMgMCwzMS44IDI1LjgsNTcuNiA1Ny42LDU3LjYgMzEuOCwwIDU3LjYwMDAxLC0yNS44IDU3LjYwMDAxLC01Ny42IDAuMSwtMzEuOSAtMjUuNywtNTcuNiAtNTcuNjAwMDEsLTU3LjYgeiIgICAgIHN0eWxlPSJmaWxsOiNlNmU2ZTYiICAgICBpZD0icGF0aDExIiAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIgLz4gIDx0ZXh0ICAgICBzb2RpcG9kaTpsaW5lc3BhY2luZz0iMTAwJSIgICAgIGlkPSJ0ZXh0MzQxOCIgICAgIHk9IjExMi4xODExNyIgICAgIHg9IjIwLjA1NDk0OSIgICAgIHN0eWxlPSJmb250LXN0eWxlOm5vcm1hbDtmb250LXZhcmlhbnQ6bm9ybWFsO2ZvbnQtd2VpZ2h0OjUwMDtmb250LXN0cmV0Y2g6bm9ybWFsO2ZvbnQtc2l6ZToxNDAuNTcwNjkzOTdweDtsaW5lLWhlaWdodDoxMDAlO2ZvbnQtZmFtaWx5OkN1cnNvcjstaW5rc2NhcGUtZm9udC1zcGVjaWZpY2F0aW9uOidDdXJzb3IsIE1lZGl1bSc7dGV4dC1hbGlnbjpzdGFydDtsZXR0ZXItc3BhY2luZzowcHg7d29yZC1zcGFjaW5nOjBweDt3cml0aW5nLW1vZGU6bHItdGI7dGV4dC1hbmNob3I6c3RhcnQ7ZmlsbDojZTZlNmU2O2ZpbGwtb3BhY2l0eToxO3N0cm9rZTpub25lO3N0cm9rZS13aWR0aDoxcHg7c3Ryb2tlLWxpbmVjYXA6YnV0dDtzdHJva2UtbGluZWpvaW46bWl0ZXI7c3Ryb2tlLW9wYWNpdHk6MSIgICAgIHhtbDpzcGFjZT0icHJlc2VydmUiPjx0c3BhbiAgICAgICBzb2RpcG9kaTpyb2xlPSJsaW5lIiAgICAgICBpZD0idHNwYW4zMzM4IiAgICAgICB4PSIyMC4wNTQ5NDkiICAgICAgIHk9IjExMi4xODExNyI%2BUHk8L3RzcGFuPjwvdGV4dD48L3N2Zz4=

An under review would be:

https://img.shields.io/:PyOpenSci-Under%20Rewiew-yellow.svg?logo=data:image/svg%2Bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8%2BPHN2ZyAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIgICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIiAgIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIgICB4bWxuczpzdmc9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgICB4bWxuczpzb2RpcG9kaT0iaHR0cDovL3NvZGlwb2RpLnNvdXJjZWZvcmdlLm5ldC9EVEQvc29kaXBvZGktMC5kdGQiICAgeG1sbnM6aW5rc2NhcGU9Imh0dHA6Ly93d3cuaW5rc2NhcGUub3JnL25hbWVzcGFjZXMvaW5rc2NhcGUiICAgdmVyc2lvbj0iMS4xIiAgIGlkPSJMYXllcl8xIiAgIHg9IjBweCIgICB5PSIwcHgiICAgdmlld0JveD0iMjcuMTkyOTgyMTk2ODA3ODYgMTAuMTk3MzY4NjIxODI2MTcyIDIwMy45NDczNTI4ODYxOTk5NSAyMTIuMTE2NjY4NzAxMTcxODgiICAgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgNzc1IDI3Ni43OyIgICBpbmtzY2FwZTp2ZXJzaW9uPSIwLjkxIHIxMzcyNSIgICBzb2RpcG9kaTpkb2NuYW1lPSJQeU9wZW5TY2kuc3ZnIj4gIDxtZXRhZGF0YSAgICAgaWQ9Im1ldGFkYXRhMTciPiAgICA8cmRmOlJERj4gICAgICA8Y2M6V29yayAgICAgICAgIHJkZjphYm91dD0iIj4gICAgICAgIDxkYzpmb3JtYXQ%2BaW1hZ2Uvc3ZnK3htbDwvZGM6Zm9ybWF0PiAgICAgICAgPGRjOnR5cGUgICAgICAgICAgIHJkZjpyZXNvdXJjZT0iaHR0cDovL3B1cmwub3JnL2RjL2RjbWl0eXBlL1N0aWxsSW1hZ2UiIC8%2BICAgICAgPC9jYzpXb3JrPiAgICA8L3JkZjpSREY%2BICA8L21ldGFkYXRhPiAgPGRlZnMgICAgIGlkPSJkZWZzMTUiIC8%2BICA8c29kaXBvZGk6bmFtZWR2aWV3ICAgICBwYWdlY29sb3I9IiNmZmZmZmYiICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIgICAgIGJvcmRlcm9wYWNpdHk9IjEiICAgICBvYmplY3R0b2xlcmFuY2U9IjEwIiAgICAgZ3JpZHRvbGVyYW5jZT0iMTAiICAgICBndWlkZXRvbGVyYW5jZT0iMTAiICAgICBpbmtzY2FwZTpwYWdlb3BhY2l0eT0iMCIgICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjIiICAgICBpbmtzY2FwZTp3aW5kb3ctd2lkdGg9IjM4NDAiICAgICBpbmtzY2FwZTp3aW5kb3ctaGVpZ2h0PSIyMDMxIiAgICAgaWQ9Im5hbWVkdmlldzEzIiAgICAgc2hvd2dyaWQ9ImZhbHNlIiAgICAgaW5rc2NhcGU6em9vbT0iNC40NTAzODEiICAgICBpbmtzY2FwZTpjeD0iLTMxLjQ0ODYzOSIgICAgIGlua3NjYXBlOmN5PSI5NS43MTYyNzEiICAgICBpbmtzY2FwZTp3aW5kb3cteD0iMCIgICAgIGlua3NjYXBlOndpbmRvdy15PSI1NSIgICAgIGlua3NjYXBlOndpbmRvdy1tYXhpbWl6ZWQ9IjEiICAgICBpbmtzY2FwZTpjdXJyZW50LWxheWVyPSJMYXllcl8xIiAvPiAgPHN0eWxlICAgICB0eXBlPSJ0ZXh0L2NzcyIgICAgIGlkPSJzdHlsZTMiPi5zdDB7ZmlsbDojMUExQTFBO308L3N0eWxlPiAgPHBhdGggICAgIGNsYXNzPSJzdDAiICAgICBkPSJtIDE3MS44NzkwOSwxMDYuMzY1NyAwLC04LjkwMDAwNCAtMjEuMywxOS41MDAwMDQgMjEuMywyMC40IDAsLTguOSBjIDIwLjMsMCAzMi40MDAwMSwxNy42IDMyLjQwMDAxLDM1LjUgMCwxNy45IC0xMi41LDM2LjEgLTMyLjQwMDAxLDM2LjEgLTIxLjU5OTk5LDAgLTMyLjM5OTk5LC0xOC4yIC0zMi4zOTk5OSwtMzYuMSBsIC0yNS4yMDAwMSwwIGMgMCwzMS44IDI1LjgsNTcuNiA1Ny42LDU3LjYgMzEuOCwwIDU3LjYwMDAxLC0yNS44IDU3LjYwMDAxLC01Ny42IDAuMSwtMzEuOSAtMjUuNywtNTcuNiAtNTcuNjAwMDEsLTU3LjYgeiIgICAgIHN0eWxlPSJmaWxsOiNlNmU2ZTYiICAgICBpZD0icGF0aDExIiAgICAgaW5rc2NhcGU6Y29ubmVjdG9yLWN1cnZhdHVyZT0iMCIgLz4gIDx0ZXh0ICAgICBzb2RpcG9kaTpsaW5lc3BhY2luZz0iMTAwJSIgICAgIGlkPSJ0ZXh0MzQxOCIgICAgIHk9IjExMi4xODExNyIgICAgIHg9IjIwLjA1NDk0OSIgICAgIHN0eWxlPSJmb250LXN0eWxlOm5vcm1hbDtmb250LXZhcmlhbnQ6bm9ybWFsO2ZvbnQtd2VpZ2h0OjUwMDtmb250LXN0cmV0Y2g6bm9ybWFsO2ZvbnQtc2l6ZToxNDAuNTcwNjkzOTdweDtsaW5lLWhlaWdodDoxMDAlO2ZvbnQtZmFtaWx5OkN1cnNvcjstaW5rc2NhcGUtZm9udC1zcGVjaWZpY2F0aW9uOidDdXJzb3IsIE1lZGl1bSc7dGV4dC1hbGlnbjpzdGFydDtsZXR0ZXItc3BhY2luZzowcHg7d29yZC1zcGFjaW5nOjBweDt3cml0aW5nLW1vZGU6bHItdGI7dGV4dC1hbmNob3I6c3RhcnQ7ZmlsbDojZTZlNmU2O2ZpbGwtb3BhY2l0eToxO3N0cm9rZTpub25lO3N0cm9rZS13aWR0aDoxcHg7c3Ryb2tlLWxpbmVjYXA6YnV0dDtzdHJva2UtbGluZWpvaW46bWl0ZXI7c3Ryb2tlLW9wYWNpdHk6MSIgICAgIHhtbDpzcGFjZT0icHJlc2VydmUiPjx0c3BhbiAgICAgICBzb2RpcG9kaTpyb2xlPSJsaW5lIiAgICAgICBpZD0idHNwYW4zMzM4IiAgICAgICB4PSIyMC4wNTQ5NDkiICAgICAgIHk9IjExMi4xODExNyI%2BUHk8L3RzcGFuPjwvdGV4dD48L3N2Zz4=
1 Like

totally! How did you create it @ocefpaf i think if you use a san serif font that will do the trick? Do you have a file that i can play with? i’m not sure what font they are using but something like century gothic might work nicely. something round. Arial is also san serif.

I got the ROpenSci svg, removed the R, and added the Py with inkscape :slight_smile:

Then you still need to convert the image to base64 to use in the shields.io link but that can be done in this site.

PS: looks like I cannot upload SVGs here :frowning:
What would be an appropriate repository to keep those files?
(Meanwhile I’m sending them to you via e-mail.)

2 Likes

Got your email :slight_smile: i’ll play with this a bit later today!
and YES that is a great idea to store these things in a general repo. I know in general using git for images isn’t ideal but these guys are small. Should we create a pyopensci resources repo in our organization to store things like this? Then things are all in one place! i’m happy to do that if it seems like a good solution for now.

1 Like

I’m +1 for a “static resources” folder in a repo somewhere. Why can keep images, logos, banners, etc.

2 Likes

awesome. how about here:
https://github.com/pyOpenSci/governance
dirname:
images

1 Like

ok i have played with it a bit. If we want to use Py rather than P by itself then i think we should go with what you created @ocefpaf !! i’m fine with that for now!! It could be a tad bit cleaner with just a “p” but honestly i do like what you created and i see the challenges with it being such a tiny graphic!! i’ve pushed another version up to github alone with a little readme that documents how you did this!!

https://github.com/pyOpenSci/governance/tree/master/images

@marskar are you open to adding that badge to your readme?? it should link to i think the original software-review submission that you provided ?? that is what it seems like R does.

1 Like

Thank you again @ocefpaf for working on this!!! i think it’s great.

1 Like

@lwasser, it would be an honor to add that badge to the nbless readme! Yes, ropensci badges link to the review issue.
UPDATE: Here is what the badge looks like on GitHub and as Sphinx docs page (Alabaster theme).
UPDATE2: I know the logo in the badge is not right. Can we update PyOpenSci-Peer%20Reviewed-success.svg instead of including the logo as ?logo=data:image/svg...? :slight_smile:

1 Like

@marskar are you suggesting that we remove the little logo from the badge?
we were trying to follow RO’s badge but perhaps i’m not following your request!

the logo should embed using this code
pyopensci badge but maybe there is a kink in using this url?? please let me know!

1 Like