https://github.com/aboutcode-org/scorecode
A library to fetch and store various software package score, like OpenSSF Scorecard data.
https://github.com/aboutcode-org/scorecode
Last synced: 8 months ago
JSON representation
A library to fetch and store various software package score, like OpenSSF Scorecard data.
- Host: GitHub
- URL: https://github.com/aboutcode-org/scorecode
- Owner: aboutcode-org
- License: apache-2.0
- Created: 2024-05-27T16:58:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-23T13:12:08.000Z (over 1 year ago)
- Last Synced: 2024-11-08T15:18:57.247Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 107 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
=============================
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:
.. code-block:: bash
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:
.. code-block:: python
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:
.. code-block:: bash
make test