sparkler

A command line tool for generating sparklines from GitHub stats.

GitHub has several APIs for extracting activity statistics in a raw JSON format. Sparkler is a tool that can take this raw data and generate sparkline images to show the activity level over a period of time.

Sparkler will create a sparkline of the commit activity over the last year.

Installing

Sparkler can be installed with pip:

$ pip install --user sparkler

Using

There are two inputs required when running sparkler, the GitHub repo you wish to graph and the name of the file to save the graph.

To get the last year’s commit activity for the kubernetes/kubernetes repo, use the command line:

sparkler kubernetes/kubernetes activity.jpg

Additional options are available for setting the foreground and background colors of the generated graph. Refer to the help text for details:

sparkler -h
usage: sparkler [-h] [--version] [--background BACKGROUND] [--line LINE]
                repo outfile

positional arguments:
  repo                  The GitHub org/repo to report on.
  outfile               The file name for the generated image. Note: Due to
                        current library issues, this must be a jpg.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --background BACKGROUND
                        The background color of the sparkline image.
  --line LINE           The sparkline image line color.

Feel free to open GitHub Issues or put up a pull request.

Metadata

Release files for sparkler 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sparkler 0.3.0
File	Size	Uploaded	Provenance
sparkler-0.3.0.tar.gz	14.8 kB	Jul 8, 2019	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for sparkler 0.3.0
File	Interpreter	ABI	Platform	Reset
sparkler-0.3.0-py2.py3-none-any.whl 10.4 kB Jul 8, 2019 Without provenance	Python 3, Python 2	none	any	Details

Total release size: 25.2 kB

Release files / sparkler-0.3.0.tar.gz

Download URL	sparkler-0.3.0.tar.gz
Size	14.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`a7f39e5913082da5c67e9ac0abb3afad0e15cbfe3341a683b453159a36569934`
BLAKE2b-256 checksum How to use checksums	`6ceab7992048c93c5dd19176e21af756a6768148e91f3739b5d00b34f892d2df`
Upload date	Jul 8, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3`

Release files / sparkler-0.3.0-py2.py3-none-any.whl

Download URL	sparkler-0.3.0-py2.py3-none-any.whl
Size	10.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`ddcaf5820c401adc3c5d5e84d64c63478f80334cb5dfdda64dac47a1992353ff`
BLAKE2b-256 checksum How to use checksums	`a3955d432a4d82960b3f6ffe46b42cbf1d9c58f50be0480a99f52bce5ee411f1`
Upload date	Jul 8, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3`

Security for sparkler 0.3.0

Report project as malware

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.