# [SOOS Core SCA](https://soos.io/sca-product)
SOOS is an independent software security company, located in Winooski, VT USA, building security software for your team. [SOOS, Software security, simplified](https://soos.io).
Use SOOS to scan your software for [vulnerabilities](https://app.soos.io/research/vulnerabilities) and [open source license](https://app.soos.io/research/licenses) issues with [SOOS Core SCA](https://soos.io/sca-product). [Generate SBOMs](https://kb.soos.io/help/soos-reports-for-export). Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/dast-product) against your web apps or APIs.
[Demo SOOS](https://app.soos.io/demo) or [Register for a Free Trial](https://app.soos.io/register).
If you maintain an Open Source project, sign up for the Free as in Beer [SOOS Community Edition](https://soos.io/products/community-edition).
## soos-ci-analysis-python
Python script to run SOOS Core SCA
## Supported Languages and Package Managers
Our full list of supported manifest formats can be found [here](https://kb.soos.io/help/soos-languages-supported).
## Need an Account?
**Visit [soos.io](https://app.soos.io/register) to create your trial account.**
## Running the Script
See [Script Knowlege Base Documentation](https://github.com/soos-io/kb-docs/blob/main/SCA/Script.md)
### Linux Shell Script Example
See [Linux GitHub Gist](https://gist.githubusercontent.com/soostech/bf4fe3c320f7457a81f2e48ebe057aa5/raw/7fcba97f88c524b2d1e3eddf2c29de52af13a0c4/soos_sca.sh)
### Windows CMD Script Example
See [Windows Batch File Gist](https://gist.githubusercontent.com/soostech/37134fb636da3246d275b2ee220669c1/raw/0ab31b1c50869d8e8061deee4fa04e8ff7169f77/soos_sca.bat)
### Script Arguments
| Argument | Default | Description |
| --- | --- | --- |
| -h, --help | ==SUPPRESS== | show this help message and exit |
| -hf, --helpFormatted | False | Print the --help command in markdown table format |
| -m, --mode | run_and_wait | Mode of operation:<br>run_and_wait: Run Analysis & Wait ** Default Value,<br>async_init: Async Init,<br>async_result: Async Result<br>For more information about scan modes, visit https://github.com/soos-io/kb-docs/blob/main/SCA/Script.md |
| -of, --onFailure | continue_on_failure | On Failure:<br>fail_the_build: Fail The Build<br>continue_on_failure: Continue On Failure ** Default Value |
| -dte, --directoriesToExclude | None | Listing of directories (relative to ./) to exclude from the search for manifest files.<br>Example - Correct: bin/start/<br>Example - Incorrect: ./bin/start/<br>Example - Incorrect: /bin/start |
| -fte, --filesToExclude | None | Listing of files (relative to ./) to exclude from the search for manifest files.<br>Example - Correct: bin/start/requirements.txt<br>Example - Incorrect: ./bin/start/requirements.txt<br>Example - Incorrect: /bin/start/requirements.txt |
| -wd, --workingDirectory | None | Absolute path where SOOS may write and read persistent files for the given build.<br>Example - Correct: /tmp/workspace/<br>Example - Incorrect: ./bin/start/<br>Example - Incorrect: tmp/workspace |
| -armw, --resultMaxWait | 300 | Maximum seconds to wait for Analysis Result. Default 300. |
| -arpi, --resultPollingInterval | 10 | Polling interval (in seconds) for analysis result completion (success/failure).<br>Min value: 10 |
| -pm, --packageManagers | None | A list of package managers, delimited by comma, to include when searching for manifest files. |
| -buri, --baseUri | https://api.soos.io/api/ | SOOS API URI Path. Default Value: https://api.soos.io/api/<br>Intended for internal use only. |
| -scp, --sourceCodePath | None | Root path to begin recursive search for manifests. Default Value: ./ |
| -pn, --projectName | None | Project name for tracking results, (this will be the one used inside of the SOOS App) |
| -cid, --clientId | None | Client ID, get yours from https://app.soos.io/integrate/sca |
| -akey, --apiKey | None | API Key, get yours from https://app.soos.io/integrate/sca |
| -v, --verbosity | INFO | Set logging verbosity level value (INFO/DEBUG) |
| --verbose | False | Enable verbose logging |
| -ch, --commitHash | None | Commit Hash Value |
| -bn, --branchName | None | Branch Name |
| -bruri, --branchUri | None | Branch URI |
| -bldver, --buildVersion | None | Build Version |
| -blduri, --buildUri | None | Build URI |
| -oe, --operatingEnvironment | None | Operating Environment |
| -appver, --appVersion | None | App Version. Intended for internal use only. |
| -intn, --integrationName | None | Integration Name (e.g. Provider) |
| -intt, --integrationType | None | Integration Type. Intended for internal use only. |
| -sarif | False | Generates SARIF Report that later can be uploaded to GitHub |
## Feedback and Support
See [SOOS Knowledge Base](https://kb.soos.io/help)
Raw data
{
"_id": null,
"home_page": "https://github.com/soos-io/soos-ci-analysis-python",
"name": "soos-sca",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.6",
"maintainer_email": "",
"keywords": "",
"author": "SOOS",
"author_email": "dev@soos.io",
"download_url": "https://files.pythonhosted.org/packages/70/6a/850f1e4652eb51c0b2da19e76cbc2332a8d85f818ace078fd99b19b2756d/soos-sca-1.7.15.tar.gz",
"platform": null,
"description": "# [SOOS Core SCA](https://soos.io/sca-product)\n\nSOOS is an independent software security company, located in Winooski, VT USA, building security software for your team. [SOOS, Software security, simplified](https://soos.io).\n\nUse SOOS to scan your software for [vulnerabilities](https://app.soos.io/research/vulnerabilities) and [open source license](https://app.soos.io/research/licenses) issues with [SOOS Core SCA](https://soos.io/sca-product). [Generate SBOMs](https://kb.soos.io/help/soos-reports-for-export). Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/dast-product) against your web apps or APIs.\n\n[Demo SOOS](https://app.soos.io/demo) or [Register for a Free Trial](https://app.soos.io/register).\n\nIf you maintain an Open Source project, sign up for the Free as in Beer [SOOS Community Edition](https://soos.io/products/community-edition).\n\n## soos-ci-analysis-python\nPython script to run SOOS Core SCA\n\n## Supported Languages and Package Managers\nOur full list of supported manifest formats can be found [here](https://kb.soos.io/help/soos-languages-supported).\n\n## Need an Account?\n**Visit [soos.io](https://app.soos.io/register) to create your trial account.**\n\n## Running the Script\nSee [Script Knowlege Base Documentation](https://github.com/soos-io/kb-docs/blob/main/SCA/Script.md)\n\n### Linux Shell Script Example\nSee [Linux GitHub Gist](https://gist.githubusercontent.com/soostech/bf4fe3c320f7457a81f2e48ebe057aa5/raw/7fcba97f88c524b2d1e3eddf2c29de52af13a0c4/soos_sca.sh)\n\n### Windows CMD Script Example\nSee [Windows Batch File Gist](https://gist.githubusercontent.com/soostech/37134fb636da3246d275b2ee220669c1/raw/0ab31b1c50869d8e8061deee4fa04e8ff7169f77/soos_sca.bat)\n\n### Script Arguments\n| Argument | Default | Description |\n| --- | --- | --- |\n| -h, --help | ==SUPPRESS== | show this help message and exit |\n| -hf, --helpFormatted | False | Print the --help command in markdown table format |\n| -m, --mode | run_and_wait | Mode of operation:<br>run_and_wait: Run Analysis & Wait ** Default Value,<br>async_init: Async Init,<br>async_result: Async Result<br>For more information about scan modes, visit https://github.com/soos-io/kb-docs/blob/main/SCA/Script.md |\n| -of, --onFailure | continue_on_failure | On Failure:<br>fail_the_build: Fail The Build<br>continue_on_failure: Continue On Failure ** Default Value |\n| -dte, --directoriesToExclude | None | Listing of directories (relative to ./) to exclude from the search for manifest files.<br>Example - Correct: bin/start/<br>Example - Incorrect: ./bin/start/<br>Example - Incorrect: /bin/start |\n| -fte, --filesToExclude | None | Listing of files (relative to ./) to exclude from the search for manifest files.<br>Example - Correct: bin/start/requirements.txt<br>Example - Incorrect: ./bin/start/requirements.txt<br>Example - Incorrect: /bin/start/requirements.txt |\n| -wd, --workingDirectory | None | Absolute path where SOOS may write and read persistent files for the given build.<br>Example - Correct: /tmp/workspace/<br>Example - Incorrect: ./bin/start/<br>Example - Incorrect: tmp/workspace |\n| -armw, --resultMaxWait | 300 | Maximum seconds to wait for Analysis Result. Default 300. |\n| -arpi, --resultPollingInterval | 10 | Polling interval (in seconds) for analysis result completion (success/failure).<br>Min value: 10 |\n| -pm, --packageManagers | None | A list of package managers, delimited by comma, to include when searching for manifest files. |\n| -buri, --baseUri | https://api.soos.io/api/ | SOOS API URI Path. Default Value: https://api.soos.io/api/<br>Intended for internal use only. |\n| -scp, --sourceCodePath | None | Root path to begin recursive search for manifests. Default Value: ./ |\n| -pn, --projectName | None | Project name for tracking results, (this will be the one used inside of the SOOS App) |\n| -cid, --clientId | None | Client ID, get yours from https://app.soos.io/integrate/sca |\n| -akey, --apiKey | None | API Key, get yours from https://app.soos.io/integrate/sca |\n| -v, --verbosity | INFO | Set logging verbosity level value (INFO/DEBUG) |\n| --verbose | False | Enable verbose logging |\n| -ch, --commitHash | None | Commit Hash Value |\n| -bn, --branchName | None | Branch Name |\n| -bruri, --branchUri | None | Branch URI |\n| -bldver, --buildVersion | None | Build Version |\n| -blduri, --buildUri | None | Build URI |\n| -oe, --operatingEnvironment | None | Operating Environment |\n| -appver, --appVersion | None | App Version. Intended for internal use only. |\n| -intn, --integrationName | None | Integration Name (e.g. Provider) |\n| -intt, --integrationType | None | Integration Type. Intended for internal use only. |\n| -sarif | False | Generates SARIF Report that later can be uploaded to GitHub |\n\n\n## Feedback and Support\nSee [SOOS Knowledge Base](https://kb.soos.io/help)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Software security, simplified.",
"version": "1.7.15",
"project_urls": {
"About": "https://soos.io",
"Homepage": "https://github.com/soos-io/soos-ci-analysis-python",
"Issues": "https://github.com/soos-io/soos-ci-analysis-python/issues",
"Register": "https://app.soos.io/register",
"Source": "https://github.com/soos-io/soos-ci-analysis-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8687c4c3ba80ee44e4354f137bdff91389bd3efdae4f29b40a0bf1ec1c2bfa47",
"md5": "3421fbdfa6189e1d889a844899e0ad1e",
"sha256": "8878708f592b6fb8535668419e3ff636136557ce9367f2606497bfe8452635d9"
},
"downloads": -1,
"filename": "soos_sca-1.7.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3421fbdfa6189e1d889a844899e0ad1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.6",
"size": 20534,
"upload_time": "2023-11-15T18:37:25",
"upload_time_iso_8601": "2023-11-15T18:37:25.426798Z",
"url": "https://files.pythonhosted.org/packages/86/87/c4c3ba80ee44e4354f137bdff91389bd3efdae4f29b40a0bf1ec1c2bfa47/soos_sca-1.7.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "706a850f1e4652eb51c0b2da19e76cbc2332a8d85f818ace078fd99b19b2756d",
"md5": "b1abe4058cb66c0efe484f862585dbeb",
"sha256": "b59f536bda1b123694eb379cc26dd038b1b794f037f3e4eea13b82b5b99aef7d"
},
"downloads": -1,
"filename": "soos-sca-1.7.15.tar.gz",
"has_sig": false,
"md5_digest": "b1abe4058cb66c0efe484f862585dbeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 23008,
"upload_time": "2023-11-15T18:37:27",
"upload_time_iso_8601": "2023-11-15T18:37:27.246521Z",
"url": "https://files.pythonhosted.org/packages/70/6a/850f1e4652eb51c0b2da19e76cbc2332a8d85f818ace078fd99b19b2756d/soos-sca-1.7.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-15 18:37:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soos-io",
"github_project": "soos-ci-analysis-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "soos-sca"
}
JSON
