Snyk Python

This producer component that runs Snyk for Python.

Read more about what it does on the Snyk homepage and GitHub repo.

How to use with Smithy

Open-Source

1. Add the Helm package to the pipeline settings:

---
# file: ./my-pipeline/kustomization.yaml
components:
  - pkg:helm/smithy-security-oss-components/producer-snyk-python

2. Configure the run parameter of the component in the pipeline run file.

# file: ./my-pipeline/pipelinerun.yaml
---
...
spec:
...
  params:
  - name: producer-snyk-python-api-key
    value: <your snyk api key>

SaaS

1. In the Smithy UI, open the page to create a new workflow.
2. Find the Snyk Python in the Producers dropdown.
3. Configure the parameters in the form on the right

Options

You can configure this component with the following options. The options that have a default value are optional:

Option Name	Description	Default	Type
[Required] producer-snyk-python-api-key	Snyk API key		String
producer-snyk-python-relative-path-to-requirements-txt	Relative path to the requirtements.txt	""	String