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).
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:
<!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
Dependencies
CLI Tool Dependencies
Python 2.7+ or 3.4+
Tested environment
Web browser |
Version |
|---|---|
Google Chrome |
57.0 or newer |
Mozilla Firefox |
52.0 or newer |
Documentation
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.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ghscard-0.0.11.tar.gz.
File metadata
- Download URL: ghscard-0.0.11.tar.gz
- Upload date:
- Size: 200.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
20dc7a3efe6878cd0e1fd8c23527a483a1a288af597a80ee4649fa21987cdd28
|
|
| MD5 |
c3d5499d97d9cd0d59050a1ca24c50d5
|
|
| BLAKE2b-256 |
5dc1546f3141fc4596fb959caa2373465cd5470e025c8e60a97926ea22deb43d
|
File details
Details for the file ghscard-0.0.11-py2.py3-none-any.whl.
File metadata
- Download URL: ghscard-0.0.11-py2.py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de15c6f6f7e02a1b98b181c1206424be47c673ba30fbe8d24fef20fd782b7e26
|
|
| MD5 |
40a66eae078e64c792566c6c5e589dbe
|
|
| BLAKE2b-256 |
f47d29229d8518b23ef9a877f0b255db51177ae6bfec113ee32bd47b24cc9fd2
|
