There is a feature branch with ideal API tests without a working app. This may or may not be used. It was partially an experiment

Consider moving out resource and note content to other repo to keep cheatsheets lighter, but then link to it

Inspired by coverage - https://github.com/nedbat/coveragepy

These use readthedocs and .rst so the code is light

Code coverage testing for Python.

|  |license| |versions| |status|
|  |ci-status| |win-ci-status| |docs| |codecov|
|  |kit| |format| |repos| |downloads|
|  |stars| |forks| |contributors|
|  |tidelift| |twitter-coveragepy| |twitter-nedbat|

Of interest:

• python is 2.7 | 3.5 ... and prefixed with symbol
• contributors
• in repositories
• downloads - only makes sense for package
• stars and forks are both included and use github icon prefix

e.g. https://github.com/foo/bar

Including for https://github.com/janl/mustache.js

This works in plain markdown!

[<img src='https://cdn.jsdelivr.net/npm/[email protected]/icons/icloud.svg' alt='website' height='40'>](https://arturssmirnovs.github.io/github-profile-readme-generator/)  

From https://github.com/arturssmirnovs/github-profile-readme-generator

Use public API.

See issue #24

See notes

https://github.com/MichaelCurrin/cheatsheets/tree/master/cheatsheets/github/api/v3

Darker background and deeper blue and flat. Also look into long cache

colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=github

[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Link%20Checker-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=github)](https://github.com/marketplace/actions/link-checker)

Standard:

Add matching patterns on fields and cleaning (e.g. space to %20) on result

Use binary data...

https://stackoverflow.com/questions/38985050/how-do-i-use-the-logo-option-in-shields-io-badges

encode e.g. https://b64.io/
or shell tool

And percent encode it

http://meyerweb.com/eric/tools/dencoder/

This can go in a recipe/cheatsheet guide too for the overall process and specific tools (or reference those tools in existing docs).

https://img.shields.io/badge/gadget-Raspberry%20Pi-pink.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI0MCIgaGVpZ2h0PSI0MCIgdmlld0JveD0iMTIgMTIgNDAgNDAiPjxwYXRoIGZpbGw9IiMzMzMzMzMiIGQ9Ik0zMiwxMy40Yy0xMC41LDAtMTksOC41LTE5LDE5YzAsOC40LDUuNSwxNS41LDEzLDE4YzEsMC4yLDEuMy0wLjQsMS4zLTAuOWMwLTAuNSwwLTEuNywwLTMuMiBjLTUuMywxLjEtNi40LTIuNi02LjQtMi42QzIwLDQxLjYsMTguOCw0MSwxOC44LDQxYy0xLjctMS4yLDAuMS0xLjEsMC4xLTEuMWMxLjksMC4xLDIuOSwyLDIuOSwyYzEuNywyLjksNC41LDIuMSw1LjUsMS42IGMwLjItMS4yLDAuNy0yLjEsMS4yLTIuNmMtNC4yLTAuNS04LjctMi4xLTguNy05LjRjMC0yLjEsMC43LTMuNywyLTUuMWMtMC4yLTAuNS0wLjgtMi40LDAuMi01YzAsMCwxLjYtMC41LDUuMiwyIGMxLjUtMC40LDMuMS0wLjcsNC44LTAuN2MxLjYsMCwzLjMsMC4yLDQuNywwLjdjMy42LTIuNCw1LjItMiw1LjItMmMxLDIuNiwwLjQsNC42LDAuMiw1YzEuMiwxLjMsMiwzLDIsNS4xYzAsNy4zLTQuNSw4LjktOC43LDkuNCBjMC43LDAuNiwxLjMsMS43LDEuMywzLjVjMCwyLjYsMCw0LjYsMCw1LjJjMCwwLjUsMC40LDEuMSwxLjMsMC45YzcuNS0yLjYsMTMtOS43LDEzLTE4LjFDNTEsMjEuOSw0Mi41LDEzLjQsMzIsMTMuNHoiLz48L3N2Zz4%3D

Note some options like logo=github are available but this above proves the custom image usecase

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/michaelcurrin/code-cookbook)

Note username has to be lowercased despite that not matching my actual username.

Time: y, m, w

UPDATE these seem all to give errors occasionally in my README so are not reliable

Issues
[![GitHub Issues](https://img.shields.io/github/issues/acch/ansible-boilerplate.svg)](https://github.com/acch/ansible-boilerplate/issues)

Github stars
[![GitHub Stars](https://img.shields.io/github/stars/acch/ansible-boilerplate.svg?label=github%20%E2%98%85)](https://github.com/acch/ansible-boilerplate/)

Auto license
[![License](https://img.shields.io/github/license/acch/ansible-boilerplate.svg)](LICENSE)

From https://github.com/acch/ansible-boilerplate/blob/master/README.md

Use large emoji next to docs, template or site buttons. Note it might be used to link to external project to or from homepage to repo.

Note it might not work inside a docs site homepage so might have to be unicode to avoid plugin use.

Move ruby section to https://github.com/MichaelCurrin/cheatsheets
Link the two repos
Possible rename that other one

One is for markdown docs and the other is for code, sometimes static sites.

Note that the release badge honors the checkbox for pre-release or not.
And the tag will use v0 as orange pre-release. Based on my testing show here before updating the release

![](https://img.shields.io/website?url=https://eapm.forgenst.com)

Based on https://github.com/forgenst/jekyll-statuspage

Name of action

Link to action or all

This might break a pattern of people expect, but can be what I want to do which is fine.

Maybe make a choice between the heading or the file.

If the section only contains a link to the file, then maybe the heading is not even needed. But by convention it seems to appear anyway in others' repos.

Also it is useful for being clear than a badge and if details are needed.

e.g.

[![GitHub Readme Stats](https://github-readme-stats.vercel.app/api?username=MichaelCurrin&show_icons=true)](https://github.com/anuraghazra/github-readme-stats)

https://ghbtns.com/

Code frequency per month

Total count

![tokei.rs: lines of code](https://tokei.rs/b1/github/MichaelCurrin/badge-generator)

https://github.com/XAMPPRocky/tokei

https://www.ideasawakened.com/post/code-count-badges-for-your-github-repositories

package.json

e.g.

https://shields.io/category/version or search dependency or package.json or node or npm for related badges

Prod

GitHub package.json dependency version (prod)

https://img.shields.io/github/package-json/dependency-version/developit/microbundle/@rollup/plugin-json

https://img.shields.io/github/package-json/dependency-version/developit/microbundle/rollup

For package.json

Dev dep

https://img.shields.io/github/package-json/dependency-version/developit/microbundle/dev/@babel/cli

Note @babel is the scope here. In package.json the value is @babel/cli

The default blue here is hard to read

So add color.

[![Made with Python](https://img.shields.io/badge/Made_with-Python-blue?logo=python&logoColor=white)](https://python.org)

This could be a choice.

Perhaps the left or right background should change.

Also remember to generate these sample logos using the core app logic and not hardcoding - so they stay consistent.

To avoid duplication

Draw, write, step through usecases of all my projects

Solve them all at once. To build something once and considering edgecases.

Figure out if a droplist or checkbox or multi sections or separate makes sense. Before coding it. Or applying it to sites.
Consider fixed badges vs custom badges.
Staples and per project.

Generate a hidden section

Won't always be true e.g. Netlify and GH pages

<!-- Shields from https://shields.io/ -->

<!-- Generated with Badge Generator https:// -->

Or a mix of both.

Split URL into label=X message=Y etc.

You could follow the hints on shields.io use -- to make -. This is useful for repo names and URLs without having to setup separate parameters.
but separate params end up being more readable and easier to generate and one doesn't have to remember escaping rules for dash and underscore when editing

This can be cards or buttons rather than just text/bullets

e.g.

• Repo badges - metadata badges for your repo
• Generic badges -...
• Images - ...

This could use the same text as that in each view fie.

e.g.

[MichaelCurrin/repo-boilerplates](https://github.com/MichaelCurrin/repo-boilerplates)

Find a way to include Github icon too whether from shields site or SVG

Here we have a horizontal image which has height at 300 and it gets squashed on mobile.

Actions general or specific action name

https://img.shields.io/badge/Theme-jekyll%2D-bulma-blue.svg

From https://stackoverflow.com/questions/12093050/encode-the-url-including-hyphen-and-dot-in-php

Relates to #19 but also existing badges

e.g. target: https://www.npmjs.com/package/vue

Separate left from the right

What about hyphen on the right side, encode it?

Sample:

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]

<!-- Markdown link & img dfn's -->
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
[npm-url]: https://npmjs.org/package/datadog-metrics
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics

URLs at the bottom of the page in the original but it is more convenient to keep them just under badges

Use my Twitter guide docs

Use default username and this project's name and type your own then update.

pipe separator can be used for PY versions.

eg

[![image](https://img.shields.io/pypi/v/pipenv.svg)](https://python.org/pypi/pipenv)
[![image](https://img.shields.io/pypi/l/pipenv.svg)](https://python.org/pypi/pipenv)
[![image](https://img.shields.io/pypi/pyversions/pipenv.svg)](https://python.org/pypi/pipenv)