Skip to main content

Conversion from scorecard ratings to risk ratings.

Project description

SecurityRiskCard

This package provides an simple shared way of converting security scorecard data from "wellness" into risk.

Installing

To install from PyPi:

pip install securityriskcard

If you want to install directly from source, you can do that by adding the following into your requirements.txt:

git+https://github.com/morphysm/securityriskcard.git@main

Usage example:

from securityriskcard import convert_to_risk

# Your scorecard result goes here.
data = convert_to_risk(scorecard_data)
print(json.dumps(data, indent=4))

Or if you want to test if the package is installed and you have scorecard result as json file:

python -m securityriskcard <path/to/scorecard.json>

Testing

Currently package contains some regression tests, which you can run during development or refactor to ensure data is output the same. The directory with test data also includes a script to generate output to 'freeze' current state. Do not run it until you are confident that change behaves as expected.

Project details


Download files

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

Source Distribution

securityriskcard-0.0.6.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

securityriskcard-0.0.6-py3-none-any.whl (16.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page