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
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='//cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js'></script> </body> </html>
The above HTML rendered as follows:
- Output:
-
CDN
- Version specific
https://cdn.jsdelivr.net/npm/ghscard@<version>/dist/ghscard.min.js
e.g. https://cdn.jsdelivr.net/npm/ghscard@0.4.1/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+
Tested environment
Web browser |
Version |
|---|---|
Google Chrome |
57.0 or newer |
Mozilla Firefox |
52.0 or newer |
Documentation
1 maintainer
Metadata
1 maintainer
Release files for ghscard 0.5.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ghscard-0.5.3.tar.gz | 35.5 kB | Without provenance | Details for ghscard-0.5.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ghscard-0.5.3-py3-none-any.whl | Python 3 | none | any | Details for ghscard-0.5.3-py3-none-any.whl |
Total release size: 55.0 kB
Release files / ghscard-0.5.3.tar.gz
| Download URL | ghscard-0.5.3.tar.gz |
|---|---|
| Size | 35.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c0bbed16d16fe6048d6340d7798bfc878f6687c9925cceed376e4b684f9720f7
|
|
BLAKE2b-256 checksum How to use checksums |
d83072e71e81edb178730150c5c7e5b4a0605deb6f22793a571cdf1a57ba776b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.6
|
Release files / ghscard-0.5.3-py3-none-any.whl
| Download URL | ghscard-0.5.3-py3-none-any.whl |
|---|---|
| Size | 19.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
68872f6c6f381b6a3fb71fb42551a6e46eebbe48b21571fd8dc0d16948b20509
|
|
BLAKE2b-256 checksum How to use checksums |
2c5c2e6920beea628490a6d78f9db2a9a97a295b0e6e907c78fcf25387443404
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.6
|
Security for ghscard 0.5.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
