=============================
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
Raw data
{
"_id": null,
"home_page": "https://github.com/aboutcode-org/scorecode",
"name": "scorecode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Scorecard, ScoreCode, OpenSSF, OSSF, Vulnerablity Analysis",
"author": "nexB. Inc. and others",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2d/71/9cdac7d330528a644b71df5fde9ee659868c4f439a3b563beba25bb02094/scorecode-0.0.2.tar.gz",
"platform": null,
"description": "=============================\nScoreCode\n=============================\n\nScoreCode is a tool for assessing the security and compliance of software projects. It\nevaluates various aspects of a project's security posture and generates a scorecard to help organizations understand the security risks associated with the software.\n\n**Features:**\n- Automated security assessment\n- Comprehensive scoring based on multiple criteria\n- Easy integration with existing workflows\n- Supports various platforms and repositories\n\nInstallation\n------------\n\nTo install Scorecard, you can use pip:\n\n.. code-block:: bash\n\n pip install scorecode\n\nUsage\n-----\n\nTo use Scorecard, you need to call the `fetch_scorecard` function with the appropriate parameters. Below is a basic usage example:\n\n.. code-block:: python\n\n from scorecode.ossf_scorecard import fetch_scorecard\n\n # Fetch the scorecard data for a specific platform org and repo\n data = fetch_scorecard(platform=\"github.com\", org=\"nexB\", repo=\"scancode-toolkit\")\n\n # Print the results\n print(\"Scoring Tool:\", data.scoring_tool)\n print(\"Scoring Tool Version:\", data.scoring_tool_version)\n print(\"Score Date:\", data.score_date)\n print(\"Score:\", data.score)\n print(\"Documentation URL:\", data.scoring_tool_documentation_url)\n\n\nTesting\n-------\n\nTo run the tests, use pytest. Ensure that all dependencies are installed and then execute:\n\n.. code-block:: bash\n\n make test\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A package to fetch data from OpenSSF Scorecard API",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/aboutcode-org/scorecode"
},
"split_keywords": [
"scorecard",
" scorecode",
" openssf",
" ossf",
" vulnerablity analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "272b1ec8e9adb0e222db23cb2c0a698af1b396a41c82975f70b7f365323d0b9f",
"md5": "aeb766ab331ecc5549449d9a09e55580",
"sha256": "fa5661b9712b0edd45c16eedd1aa094c4d4166118aa211874db00b2496ea4293"
},
"downloads": -1,
"filename": "scorecode-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aeb766ab331ecc5549449d9a09e55580",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11875,
"upload_time": "2024-08-23T13:12:22",
"upload_time_iso_8601": "2024-08-23T13:12:22.699105Z",
"url": "https://files.pythonhosted.org/packages/27/2b/1ec8e9adb0e222db23cb2c0a698af1b396a41c82975f70b7f365323d0b9f/scorecode-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d719cdac7d330528a644b71df5fde9ee659868c4f439a3b563beba25bb02094",
"md5": "70f52975ca5fd73ee71d4b0b9e3cae36",
"sha256": "0a2ea089f2d760f60eefd47b2e2133e99296a22e6162de40d39ecf8d61d457f1"
},
"downloads": -1,
"filename": "scorecode-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "70f52975ca5fd73ee71d4b0b9e3cae36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 68765,
"upload_time": "2024-08-23T13:12:25",
"upload_time_iso_8601": "2024-08-23T13:12:25.060522Z",
"url": "https://files.pythonhosted.org/packages/2d/71/9cdac7d330528a644b71df5fde9ee659868c4f439a3b563beba25bb02094/scorecode-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 13:12:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aboutcode-org",
"github_project": "scorecode",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "attrs",
"specs": [
[
"==",
"23.2.0"
]
]
},
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "black",
"specs": [
[
"==",
"24.4.2"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.7.4"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "commoncode",
"specs": [
[
"==",
"31.2.1"
]
]
},
{
"name": "django-environ",
"specs": [
[
"==",
"0.11.2"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "isort",
"specs": [
[
"==",
"5.13.2"
]
]
},
{
"name": "mypy-extensions",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.1"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.12.1"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.2.2"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "pycodestyle",
"specs": [
[
"==",
"2.12.0"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.3.1"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "saneyaml",
"specs": [
[
"==",
"0.6.0"
]
]
},
{
"name": "soupsieve",
"specs": [
[
"==",
"2.5"
]
]
},
{
"name": "text-unidecode",
"specs": [
[
"==",
"1.3"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.2"
]
]
}
],
"lcname": "scorecode"
}
JSON
