PyPI - Python

Collects PyPI (Python) Packages.

Details

Transfer Tag

hoppr.core_plugins.collect_pypi_plugin

Supported PURLs

pypi

System Dependencies

NONE

Transfer File Example

---
schemaVersion: v1
kind: transfer

stages:
  collect:
    plugins:
      - name: hoppr.core_plugins.collect_pypi_plugin
        config:
          process_timeout: 60

max_processes: 3

Configuration Options

Option	Details
process_timeout	Number of seconds to attempt collect before timeout. Default: 60
pip_command	String. Defaults to pip. Command to be used to execute pip commands
type	Specifies how the collection should be performed. Options:   •binary-only, binary: Collect only the binary file format (whl)   •source-only, source: Collect only the source file format (tar)   •binary-preferred: Collects source only if binary is not available Default   •source-preferred: Collects binary only if source is not available   •both-preferred: Attempts to collect both binary and source   •both-required: Must collect both binary and source

Proxy and Certificate Configuration

To configure proxies, set the following environment variables:

Environment Variable Name	Description
HTTP_PROXY	Proxy for the HTTP protocol.
HTTPS_PROXY	Proxy for the HTTPS protocol.
NO_PROXY	Comma-separated list of domains where proxies won't be used.

To configure a certificate for pip, run pip config edit and add the path to your certificate file to the cert property under the [global] section.

[global]
cert = <PATH_TO_MY_CERTIFICATE_FILE>

Credentials Configuration

To specify credentials, you need a credentials file.

Sample credentials file:

---
schemaVersion: v1
kind: Credentials

metadata:
  name: Registry Credentials
  version: v1
  description: Sample credentials file

credential_required_services:
  - url: registry.gitlab.com
    user_env: CI_REGISTRY_USER
    pass_env: CI_REGISTRY_PASSWORD

SBOM Generation Tools

• syft (cli tool)
• CycloneDX for Python (cli tool)
• cyclonedx-python-generate-sbom (GitHub Action)

note

For more tools visit the CycloneDX Tool Center