Skip to content

aboutcode-org/scorecode

Repository files navigation

ScoreCode

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

About

A library to fetch and store various software package score, like OpenSSF Scorecard data.

Resources

Security policy

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages

Generated from aboutcode-org/skeleton