Summary

ghscard is a JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages/Read the Docs).

Demo

• Popular Repositories on GitHub
• https://thombashi.github.io/

Quick Start

CLI Tool Installation

Install ghscard CLI tool from PyPI via pip (Python package manager) command.

pip install ghscard

Generate card data files

Execute ghscard gen command to generate a GitHub user/organization/repository card data file.

$ ghscard gen thombashi -o data
[INFO] ghscard gen: written user data to 'data/thombashi.json'

$ ghscard gen Microsoft/TypeScript -o data
[INFO] ghscard gen: written repository data to 'data/Microsoft_TypeScript.json'

Add widget to an HTML file

Example

: ``` {.sourceCode .html}

    <script src='//cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js'></script>
</body>
</html>
```

The above HTML rendered as follows:

Output

: {width="600px"}

CDN

Version specific

:   -   `https://cdn.jsdelivr.net/npm/ghscard@<version>/dist/ghscard.min.js`
    -   e.g.
        <https://cdn.jsdelivr.net/npm/[email protected]/dist/ghscard.min.js>

Latest version

:   -   <https://cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js>

For more information

More examples are available at https://ghscard.rtfd.io/en/latest/pages/usage/index.html

Dependencies

CLI Tool Dependencies

Python 3.5+

• appconfigpy
• click
• DateTimeRange
• logbook
• msgfy
• pathvalidate
• PyGithub
• requests
• retryrequests
• typepy

Tested environment

Documentation

https://ghscard.rtfd.io/