Skip to main content

A package to fetch data from OpenSSF Scorecard API

Project description

ScoreCode is a tool for assessing the security and compliance of software projects. It evaluates various aspects of a project’s security posture and generates a scorecard to help organizations understand the security risks associated with the software.

Features: - Automated security assessment - Comprehensive scoring based on multiple criteria - Easy integration with existing workflows - Supports various platforms and repositories

Installation

To install Scorecard, you can use pip:

pip install scorecode

Usage

To use Scorecard, you need to call the fetch_scorecard function with the appropriate parameters. Below is a basic usage example:

from scorecode.ossf_scorecard import fetch_scorecard

# Fetch the scorecard data for a specific platform org and repo
data = fetch_scorecard(platform="github.com", org="nexB", repo="scancode-toolkit")

# Print the results
print("Scoring Tool:", data.scoring_tool)
print("Scoring Tool Version:", data.scoring_tool_version)
print("Score Date:", data.score_date)
print("Score:", data.score)
print("Documentation URL:", data.scoring_tool_documentation_url)

Testing

To run the tests, use pytest. Ensure that all dependencies are installed and then execute:

make test

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

scorecode-0.0.2.tar.gz (68.8 kB view hashes)

Uploaded Source

Built Distribution

scorecode-0.0.2-py3-none-any.whl (11.9 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