A JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages).
Project description
ghscard
Summary
A JavaScript widget to generate interactive GitHub user/repository/organization cards for static web pages (like GitHub pages).
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: | <!doctype html> <html> <body> <table border="0"> <tr> <td> <div class='ghscard' src='data/thombashi.json'></div> </td> <td> <div class="ghscard" src="data/Microsoft_TypeScript.json"></div> </td> </tr> </table> <script src='//rawgit.com/thombashi/ghscard/master/dist/ghscard.min.js'></script> </body> </html> |
---|
This HTML rendered as follows:
Output: |
---|
For more information
More examples are available at https://ghscard.rtfd.io/en/latest/pages/usage/index.html
Tested environment
Web browser | Version |
---|---|
Google Chrome | 57.0 or newer |
Mozilla Firefox | 52.0 or newer |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size ghscard-0.1.3-py2.py3-none-any.whl (19.3 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size ghscard-0.1.3.tar.gz (202.2 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for ghscard-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff3798ebd12733e088523fd5c135180bcfe42bd69ede49a70c27d4872ad2db60 |
|
MD5 | 3a875a2463def5bde2d7db86b8ef8146 |
|
BLAKE2-256 | db7b21c14fa1d139a3906b6a71a7fccf62e71034bdffbc3c6cb6da93087612ca |