Command Line Tool

REQUIREMENTS

INSTALLATION

  • TODO

COMMANDS

install

Install dependencies.

USAGE

make install

SEE ALSO

  • clean -- Clean up installation and cache files.

clean

Clean up installation and cache files.

USAGE

make clean

SEE ALSO

check

Run linting, formatting, security, and type checks.

This script uses the following tools:

  • ruff -- check for linting issues and code formatting.
  • bandit -- check for security issues.
  • mypy -- check for type issues.

USAGE

make check

SEE ALSO

format

Apply formatting.

This script will use ruff to automatically fix linting issues and format the code.

USAGE

make format

SEE ALSO

  • check -- Run linting, formatting, security, and type checks.

test

Run tests.

USAGE

make test

SEE ALSO

test_coverage

Run tests with coverage reporting.

USAGE

make test_coverage

SEE ALSO

test_coverage_html

Run tests and generate HTML coverage report.

USAGE

make test_coverage_html

SEE ALSO

run_circleci_scraper

Run the CircleCI scraper.

USAGE

make run_circleci_scraper

In order to use this command, you need to make sure you set your personal CircleCI token in your local config.ini file, as seen below:

[circleci_scraper]
token = <YoUr_tOkEn_hErE>

If the days_of_data option is not present in the config.ini file, the default of "all available data" will be fetched. If you want to customize how many previous days are fetched, you can set the days_of_data option in your local config.ini file:

[circleci_scraper]
;(optional) Get data starting from x days past from now (default: all available data)
days_of_data = 7

If you have the previous day's data stored locally, the cached data will be used and not re-fetched from CircleCI.

SEE ALSO

run_metric_reporter

Run the Test Metric Reporter.

USAGE

make run_metric_reporter

SEE ALSO