# ghscard

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

Latest version **0.5.3** (published 2020-07-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install ghscard
pnpm add ghscard
yarn add ghscard
bun add ghscard
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2020-07-29 |
| First published | 2019-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 84.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Tsuyoshi Hombashi |
| Maintainers | thombashi |
| Keywords | github, card |

## Links

- npm: https://www.npmjs.com/package/ghscard
- Repository: https://github.com/thombashi/ghscard
- Issues: https://github.com/thombashi/ghscard/issues
- npm.io page: https://npm.io/package/ghscard

## Dependencies (2)

- [dayjs](https://npm.io/package/dayjs.md) ^1.8.31
- [jquery](https://npm.io/package/jquery.md) ^3.5.1

## Recent versions

- 0.5.3 (latest) — 2020-07-29
- 0.5.2 — 2020-07-25
- 0.5.1 — 2020-04-11
- 0.5.0 — 2020-04-04
- 0.4.1 — 2020-01-13
- 0.4.0 — 2020-01-12
- 0.3.0 — 2019-05-02
- 0.2.4 — 2019-04-20
- 0.2.3 — 2019-04-14
- 0.2.1 — 2019-02-17
- 0.2.0 — 2019-02-17

## README

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).

[![PyPI package version](https://badge.fury.io/py/ghscard.svg)](https://badge.fury.io/py/ghscard)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/ghscard.svg)](https://pypi.org/project/ghscard)

[![npm package version](https://img.shields.io/npm/v/ghscard)](https://www.npmjs.com/package/ghscard)

[![Linux CI status](https://img.shields.io/travis/thombashi/ghscard/master.svg?label=Linux%20CI)](https://travis-ci.org/thombashi/ghscard)

[![GitHub stars](https://img.shields.io/github/stars/thombashi/ghscard.svg?style=social&label=Star)](https://github.com/thombashi/ghscard)

Demo
====

-   [Popular Repositories on
    GitHub](https://thombashi.github.io/ghscard/demo/)
-   <https://thombashi.github.io/>

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}
    <!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

:   [![Click to navigate to the HTML page](ss/quickstart.png){width="600px"}](//thombashi.github.io/ghscard/quickstart/)

### 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>

-   

    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](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
-------------

<https://ghscard.rtfd.io/>

---
_Source: https://npm.io/package/ghscard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._