securityriskcard

Name	securityriskcard JSON
Version	0.0.5 JSON
	download
home_page	https://github.com/morphysm/securityriskcard
Summary	Conversion from scorecard ratings to risk ratings.
upload_time	2024-03-27 14:24:58
maintainer	None
docs_url	None
author	Cyberfame Team
requires_python	None
license	AGPL-3.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # SecurityRiskCard

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

### Installing

To install from PyPi:
```bash
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:
```python
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:
```bash
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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/morphysm/securityriskcard",
    "name": "securityriskcard",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Cyberfame Team",
    "author_email": "0x4480@cyberfame.io",
    "download_url": "https://files.pythonhosted.org/packages/3c/91/5c93f056d847104c299d30bacc515811efb96db562400941436fd2cb07f9/securityriskcard-0.0.5.tar.gz",
    "platform": null,
    "description": "# SecurityRiskCard\n\nThis package provides an simple shared way of converting security scorecard data from \"wellness\" into risk.\n\n### Installing\n\nTo install from PyPi:\n```bash\npip install securityriskcard\n```\n\nIf you want to install directly from source, you can do that by adding the following into your `requirements.txt`:\n```\ngit+https://github.com/morphysm/securityriskcard.git@main\n```\n\n### Usage example:\n```python\nfrom securityriskcard import convert_to_risk\n\n# Your scorecard result goes here.\ndata = convert_to_risk(scorecard_data)\nprint(json.dumps(data, indent=4))\n```\nOr if you want to test if the package is installed and you have scorecard result as json file:\n```bash\npython -m securityriskcard <path/to/scorecard.json>\n```\n\n### Testing\n\nCurrently package contains some regression tests, which you can run during development or refactor to ensure data is output the same.\nThe 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.\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "Conversion from scorecard ratings to risk ratings.",
    "version": "0.0.5",
    "project_urls": {
        "Homepage": "https://github.com/morphysm/securityriskcard"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28a3a8e870eba764f4c8176db059a388414d9e74053f4c7440318d3354a994cf",
                "md5": "8503cfd53040f009a7887f2bfd7e2b99",
                "sha256": "dce536f97e911c389cf539e027b9ded1a39e4d481fb6ff70499d4a1907e9d250"
            },
            "downloads": -1,
            "filename": "securityriskcard-0.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8503cfd53040f009a7887f2bfd7e2b99",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 16684,
            "upload_time": "2024-03-27T14:24:57",
            "upload_time_iso_8601": "2024-03-27T14:24:57.160878Z",
            "url": "https://files.pythonhosted.org/packages/28/a3/a8e870eba764f4c8176db059a388414d9e74053f4c7440318d3354a994cf/securityriskcard-0.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3c915c93f056d847104c299d30bacc515811efb96db562400941436fd2cb07f9",
                "md5": "37776f2ca564f041740a2af7bd03f829",
                "sha256": "476e12bda34e79647ce15561ebbcd016edde72ff0bb88b0026da86ca5c984c56"
            },
            "downloads": -1,
            "filename": "securityriskcard-0.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "37776f2ca564f041740a2af7bd03f829",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15332,
            "upload_time": "2024-03-27T14:24:58",
            "upload_time_iso_8601": "2024-03-27T14:24:58.947490Z",
            "url": "https://files.pythonhosted.org/packages/3c/91/5c93f056d847104c299d30bacc515811efb96db562400941436fd2cb07f9/securityriskcard-0.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 14:24:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "morphysm",
    "github_project": "securityriskcard",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "securityriskcard"
}