ghscard

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

These details have not been verified by PyPI

Project links

Project description

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

Tested environment

Tested Web Browsers
Web browser	Version
Google Chrome	57.0 or newer
Mozilla Firefox	52.0 or newer

Documentation

https://ghscard.rtfd.io/

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

0.5.3

Jul 29, 2020

0.5.2

Jul 25, 2020

0.5.0

Apr 4, 2020

0.4.1

Jan 13, 2020

0.4.0

Jan 12, 2020

0.3.1

May 11, 2019

0.3.0

May 2, 2019

0.2.4

Apr 20, 2019

0.2.3

Apr 14, 2019

0.2.2

Mar 30, 2019

0.2.1

Feb 18, 2019

0.1.4

Feb 16, 2019

0.1.3

Feb 11, 2019

0.1.2

Feb 3, 2019

0.1.1

Jan 14, 2019

0.1.0

Jan 3, 2019

0.0.16

Dec 30, 2018

0.0.15

Dec 24, 2018

0.0.14

Nov 25, 2018

0.0.13

Oct 8, 2018

0.0.12

Sep 30, 2018

0.0.11

Sep 15, 2018

0.0.10

Sep 9, 2018

0.0.9

Sep 2, 2018

0.0.8

Aug 11, 2018

0.0.7

Jul 15, 2018

0.0.6

Feb 18, 2018

0.0.5

Nov 4, 2017

0.0.4

Jul 31, 2017

0.0.3

Jul 8, 2017

0.0.2

May 5, 2017

0.0.1

Apr 4, 2017

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghscard-0.5.3.tar.gz (35.5 kB view details)

Uploaded Jul 29, 2020 Source

Built Distribution

ghscard-0.5.3-py3-none-any.whl (19.6 kB view details)

Uploaded Jul 29, 2020 Python 3

File details

Details for the file ghscard-0.5.3.tar.gz.

File metadata

Download URL: ghscard-0.5.3.tar.gz
Upload date: Jul 29, 2020
Size: 35.5 kB
Tags: Source
Uploaded using 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

File hashes

Hashes for ghscard-0.5.3.tar.gz
Algorithm	Hash digest
SHA256	`c0bbed16d16fe6048d6340d7798bfc878f6687c9925cceed376e4b684f9720f7`
MD5	`87540c86db845afea6a89d105f1d911c`
BLAKE2b-256	`d83072e71e81edb178730150c5c7e5b4a0605deb6f22793a571cdf1a57ba776b`

See more details on using hashes here.

File details

Details for the file ghscard-0.5.3-py3-none-any.whl.

File metadata

Download URL: ghscard-0.5.3-py3-none-any.whl
Upload date: Jul 29, 2020
Size: 19.6 kB
Tags: Python 3
Uploaded using 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

File hashes

Hashes for ghscard-0.5.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`68872f6c6f381b6a3fb71fb42551a6e46eebbe48b21571fd8dc0d16948b20509`
MD5	`adb427f676606563c69e10df4122699d`
BLAKE2b-256	`2c5c2e6920beea628490a6d78f9db2a9a97a295b0e6e907c78fcf25387443404`