https://github.com/SoftwareSystemsLaboratory/prime-badges
A tool to create custom badges displaying CLIME metrics
https://github.com/SoftwareSystemsLaboratory/prime-badges
Last synced: 2 months ago
JSON representation
A tool to create custom badges displaying CLIME metrics
- Host: GitHub
- URL: https://github.com/SoftwareSystemsLaboratory/prime-badges
- Owner: SoftwareSystemsLaboratory
- License: bsd-3-clause
- Created: 2021-09-28T21:52:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-22T14:40:09.000Z (about 3 years ago)
- Last Synced: 2025-03-12T13:14:56.615Z (2 months ago)
- Language: Python
- Homepage:
- Size: 438 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# CLIME Badges
> A tool to create custom badges displaying CLIME metrics
[](https://doi.org/10.5281/zenodo.6477908)
[](https://github.com/SoftwareSystemsLaboratory/clime-badges/actions/workflows/release.yml)
## Table of Contents
- [CLIME Badges](#clime-badges)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Licensing](#licensing)
- [How To Use](#how-to-use)
- [Installation](#installation)
- [Command Line Options](#command-line-options)
## 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](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`
``` shell
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
```