Summary
=======
[ghscard](https://github.com/thombashi/ghscard) is a JavaScript widget
to generate interactive GitHub user/repository/organization cards for
static web pages (like GitHub pages/Read the Docs).
[](https://badge.fury.io/py/ghscard)
[](https://pypi.org/project/ghscard)
[](https://www.npmjs.com/package/ghscard)
[](https://travis-ci.org/thombashi/ghscard)
[](https://github.com/thombashi/ghscard)
Demo
====
- [Popular Repositories on
GitHub](https://thombashi.github.io/ghscard/demo/)
-
Quick Start
===========
CLI Tool Installation
---------------------
Install `ghscard` CLI tool from [PyPI](//pypi.python.org/pypi) via
[pip](//pip.pypa.io/en/stable/installing/) (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}
```
The above HTML rendered as follows:
Output
: [{width="600px"}](//thombashi.github.io/ghscard/quickstart/)
### CDN
-
Version specific
: - `https://cdn.jsdelivr.net/npm/ghscard@/dist/ghscard.min.js`
- e.g.
-
Latest version
: -
For more information
--------------------
More examples are available at
Dependencies
============
CLI Tool Dependencies
---------------------
Python 3.5+
- [appconfigpy](https://github.com/thombashi/appconfigpy)
- [click](https://palletsprojects.com/p/click/)
- [DateTimeRange](https://github.com/thombashi/DateTimeRange)
- [logbook](https://logbook.readthedocs.io/en/stable/)
- [msgfy](https://github.com/thombashi/msgfy)
- [pathvalidate](https://github.com/thombashi/pathvalidate)
- [PyGithub](https://pygithub.readthedocs.io/en/latest/)
- [requests](http://python-requests.org/)
- [retryrequests](https://github.com/thombashi/retryrequests)
- [typepy](https://github.com/thombashi/typepy)
Tested environment
==================
Documentation
-------------