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

lwasser · July 16, 2019, 8:52pm

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:

github.com/pyOpenSci/software-review

Nbless: Software Submission for Review (APPROVED & ACCEPTED)

opened 06:27PM - 30 May 19 UTC

closed 03:45PM - 06 Aug 19 UTC

marskar

1/editor-checks 3/reviewer(s)-assigned 4/review(s)-in-awaiting-changes 5/awaiting-reviewer(s)-response 6/pyOS-approved

Submitting Author: Martin Skarzynski (@marskar) Package Name: Nbless One-Lin…e Description of Package: Construct, deconstruct, convert, execute, & prepare slides from Jupyter notebooks Repository Link: https://github.com/marskar/nbless/ Version submitted: 0.2.26 Editor: @lwasser Reviewer 1: @ocefpaf Reviewer 2: @kysolvik Archive: TBD Version accepted: TBD --- ## Description - Include a brief paragraph describing what your package does: The Nbless Python package allows you to - (de)construct, - convert, - execute, and - prepare slides from Jupyter notebooks. The Nbless Python package consists of 6 Python functions and shell commands: - `nbconv`, which converts a notebook into various formats. - `nbdeck`, which prepares a notebook to be viewed as or converted into slides. - `nbexec`, which runs a notebook from top to bottom and saves an executed version. - `nbless`, which calls nbuild and nbexec to create and execute a notebook. - `nbraze`, which extracts code and markdown files from a notebook. - `nbuild`, which creates a notebook from code and markdown files. For more on Nbless, please take a look at the [official documentation](https://marskar.github.io/nbless/readme.html). ## Scope - Please indicate which [category or categories](https://www.pyopensci.org/dev_guide/peer_review/aims_scope.html) this package falls under: - [ ] Data retrieval - [ ] Data extraction - [ ] Data munging - [ ] Data deposition - [x] Reproducibility - [ ] Geospatial - [x] Education - [ ] Data visualization* \* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see [this section](https://www.pyopensci.org/dev_guide/peer_review/aims_scope.html#notes-on-categories) of our guidebook. - Explain how and why the package falls under these categories (briefly, 1-2 sentences): Jupyter notebooks are important for reproducibility, because they facilitate literate programming, the combination of code and text. Literate programming is advantageous, because it allows descriptions of methods and results to be adjacent to the code used to obtain the results. I frequently use Jupyter notebooks in my work and in the Python classes I teach, but I often wish I could share small, simple files instead of large Jupyter notebooks. With Nbless, anyone can create Jupyter notebooks from simple source files or extract code and markdown files from Jupyter notebooks. In this way, Nbless supports round-trip conversion between source files and Jupyter notebooks. In other words, code and markdown files can be extracted from a Jupyter notebook _AND_ then used to recreate the original Jupyter notebook. This can promote the modularity principle without sacrificing the benefits of literate programming or the convenience of a single file with all code, text, and output for the project. Code and markdown files can be easily be accessed with any text editor or even opened in a browser without an internet connection. Keeping source files makes version control simpler than trying to track changes made to Jupyter notebooks (see [`nbdime`](https://github.com/jupyter/nbdime#nbdime-jupyter-notebook-diff-and-merge-tools) for another solution). Code files (`.py`, `.R`, etc.) are amenable to testing and linting, while notebooks are difficult to lint/test (see [`autopep8`](https://github.com/kenkoooo/jupyter-autopep8#jupyter-autopep8-pep8-formatter-for-jupyter-notebook) and [`nbval`](https://github.com/computationalmodelling/nbval#pytest-plugin-for-validating-jupyter-notebooks)). - Who is the target audience and what are scientific applications of this package? The target audience is anyone who uses Jupyter notebooks. This package may help teachers and researchers to improve the efficiency of their Jupyter notebook workflows. One of the major features of Nbless is that it can facilitate the creation of slides from Jupyter notebooks. Jupyter slides can be [converted in `revealjs` HTML files](https://github.com/marskar/slides#create-html-slides-from-ipynb-using-nbconvert-from-the-command-line) or viewed using [`nbviewer` or RISE/Binder](https://github.com/marskar/slides#create-html-slides-from-ipynb-using-nbconvert-from-the-command-line). I can imagine teachers and researchers writing markdown and code files and then using `nbless` to creating Jupyter notebooks to share with their students and colleagues. - Are there other Python packages that accomplish the same thing? If so, how does yours differ? Related packages include: - [`pandoc`](https://pandoc.org/MANUAL.html#creating-jupyter-notebooks-with-pandoc) - [`jupytext`](https://github.com/mwouts/jupytext) - [`notedown`](https://github.com/aaren/notedown) These packages can all convert Jupyter notebooks to other formats: markdown files (all three) or Python scripts (`jupytext`). Nbless wraps `nbconvert` to convert between file types, but it can do something all of the aforementioned packages cannot. Nbless can take a more modular approach to file conversion by extracting the contents of each notebook cell into a separate file (cell -> file) or using a source file to create each notebook cell (file -> cell). Looking beyond simple file conversion, Nbless includes a tool for making slides from notebooks (by setting `slide_type` in notebook metadata). - If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted: The pre-submission inquiry link is https://github.com/pyOpenSci/software-review/issues/4 I will close #4 as soon as I am done with #7. ## Technical checks For details about the pyOpenSci packaging requirements, see our [packaging guide](https://www.pyopensci.org/dev_guide/packaging/packaging_guide.html). Confirm each of the following by checking the box. This package: - [x] does not violate the Terms of Service of any service it interacts with. - [x] has an [OSI approved license](https://opensource.org/licenses) - [x] contains a README with instructions for installing the development version. - [x] includes documentation with examples for all functions. - [x] contains a vignette with examples of its essential functions and uses. - [x] has a test suite. - [x] has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others. ## Publication options - [ ] Do you wish to automatically submit to the [Journal of Open Source Software](http://joss.theoj.org/)? If so: <details> <summary>JOSS Checks</summary> - [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements). Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS. - [ ] The package is not a "minor utility" as defined by JOSS's [submission requirements](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements): "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria. - [ ] The package contains a `paper.md` matching [JOSS's requirements](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain) with a high-level description in the package root or in `inst/`. - [ ] The package is deposited in a long-term repository with the DOI: *Note: Do not submit your package separately to JOSS* </details> ## Are you OK with Reviewers Submitting Issues to your Repo Directly? This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links. - [x] Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review. ## Code of conduct - [x] I agree to abide by [pyOpenSci's Code of Conduct](https://www.pyopensci.org/dev_guide/peer_review/coc.html) during the review process and in maintaining my package should it be accepted. **P.S.** *Have feedback/comments about our review process? Leave a comment [here](https://github.com/pyOpenSci/governance/issues/8)*

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

marskar · July 17, 2019, 8:30pm

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/

lwasser · July 17, 2019, 9:14pm

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

lwasser · July 18, 2019, 3:55pm

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!

lwasser · July 18, 2019, 3:55pm

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

ocefpaf · July 19, 2019, 1:08pm

I guess this is their badge, right?

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

lwasser · July 19, 2019, 2:30pm

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

ocefpaf · July 19, 2019, 9:58pm

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.

ocefpaf · July 19, 2019, 10:24pm

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!) .

lwasser · July 22, 2019, 3:52pm

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 should we go ahead and use this for now?

ocefpaf · July 22, 2019, 4:16pm

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=

lwasser · July 22, 2019, 4:28pm

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.

ocefpaf · July 22, 2019, 4:46pm

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

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
What would be an appropriate repository to keep those files?
(Meanwhile I’m sending them to you via e-mail.)

lwasser · July 22, 2019, 6:29pm

Got your email 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.

ocefpaf · July 22, 2019, 6:33pm

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

lwasser · July 22, 2019, 6:48pm

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

lwasser · July 22, 2019, 7:55pm

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.

lwasser · July 22, 2019, 7:55pm

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

marskar · July 22, 2019, 8:26pm

@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...?

lwasser · July 22, 2019, 9:07pm

@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!

Topic		Replies	Views
What about projects that are not hosted on GitHub or cannot be transferred to the PyOpenSci organization Meta	3	443	June 7, 2019
BIG UPDATE to the pyOpenSci Peer Review Guide pyOpenSci Community Chat	4	139	December 28, 2022
Some experiences of doing a pyOpenSci review pyOpenSci Review Process Questions	9	436	June 6, 2019
Two new packages - any feedback? pyOpenSci Review Process Questions	0	288	December 17, 2019
pyOpenSci Package Guide PR review open! pyOpenSci Community Chat	0	131	December 29, 2022

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

Related Topics