Skip to main content

CLIME Badges

A tool to create custom badges displaying CLIME metrics

DOI Release Project

Table of Contents

About

The Software Systems Laboratory (SSL) CLIME Badges project is a tool to create custom badges displaying CLIME metrics.

Licensing

This project is licensed under the BSD-3-Clause. See the LICENSE for more information.

How To Use

Installation

You can install the tool from PyPi with one of the following one liners:

  • pip install clime-metrics
  • pip install clime-badges

Command Line Options

clime-badges -h

usage: CLIME Metric Badge Creator [-h] [-g GRAPH] [-lc LEFT_COLOR]
                                  [-lt LEFT_TEXT] [-u LINK] [-o OUTPUT]
                                  [-rt RIGHT_TEXT]
                                  [-rc--right-color RC__RIGHT_COLOR] [-v]

A tool to create a badge from a metric's graph

options:
  -h, --help            show this help message and exit
  -g GRAPH, --graph GRAPH
                        The metric graph SVG file to be used as the badge
                        logo. DEFAULT: metric.svg
  -lc LEFT_COLOR, --left-color LEFT_COLOR
                        Left side color. DEFAULT: maroon
  -lt LEFT_TEXT, --left-text LEFT_TEXT
                        Text to go on the left side of the badge. DEAULT:
                        CLIME Metric
  -u LINK, --link LINK  Link to a specific URL that will open when the badge
                        is clicked/ DEFAULT: None
  -o OUTPUT, --output OUTPUT
                        The output filename of the badge. NOTE: Must end in
                        .svg. DEFAULT: badge.svg
  -rt RIGHT_TEXT, --right-text RIGHT_TEXT
                        Text to go on the right side of the badge. DEFAULT:
                        None
  -rc--right-color RC__RIGHT_COLOR
                        Right side color. DEFAULT: gold
  -v, --version         Display version of the tool

Author(s): Nicholas M. Synovic, George K. Thiruvathukal

Metadata

Release files for clime-badges 0.3.3

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

Source distribution (sdist)

Source distribution for clime-badges 0.3.3
File Size Uploaded Provenance Actions
clime-badges-0.3.3.tar.gz 4.9 kB Without provenance Details for clime-badges-0.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for clime-badges 0.3.3
File Interpreter ABI Platform Actions
clime_badges-0.3.3-py3-none-any.whl Python 3 none any Details for clime_badges-0.3.3-py3-none-any.whl

Total release size: 10.7 kB

Release files / clime-badges-0.3.3.tar.gz

Download URL clime-badges-0.3.3.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
61a128b0bcbd3813a1d7b2c6d9b10a7b84582d4813614e475da2d4356d4d0d02
BLAKE2b-256 checksum
How to use checksums
4cc15ef64521262fd6ad18aa84d5c9b9a01d6e5ad000032064a1db487663fe03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Release files / clime_badges-0.3.3-py3-none-any.whl

Download URL clime_badges-0.3.3-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
177e2397e4e6cbe240cd5a888e5cba30379458a0e6e6bed0c7a85fb709fa4315
BLAKE2b-256 checksum
How to use checksums
414596fd55e5e84435d2c0e7b6be3da6fe55d4a9056eb605ddbe30a48111f56e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Security for clime-badges 0.3.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page