setup

package

v0.4.3 Latest Latest Go to latest Published: Feb 9, 2026 License: Apache-2.0, BSD-3-Clause, MIT Imports: 15 Imported by: 0

Details

Package setup extracts packages from setup.py.

View Source

const (
	// Name is the unique name of this extractor.
	Name = "python/setup"
)

This section is empty.

func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)

New returns a setup.py extractor.

type Extractor struct {
	Stats stats.Collector
	// contains filtered or unexported fields
}

Extractor extracts python packages from setup.py.

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)

Extract extracts packages from setup.py files passed through the scan input.

func (e Extractor) FileRequired(api filesystem.FileAPI) bool

FileRequired returns true if the specified file matches python setup.py file pattern.

func (e Extractor) Name() string

Name of the extractor.

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (e Extractor) Version() int

Version of the extractor.

type Metadata struct {
	// The comparator used to compare the package version, e.g. ==, ~=, >=
	VersionComparator string
}

Metadata contains additional information from a package in a setup.py file.

func ToStruct(m *pb.PythonSetupMetadata) *Metadata

ToStruct converts the PythonSetupMetadata proto to a Metadata struct.

func (m *Metadata) SetProto(p *pb.Package)

SetProto sets the PythonSetupMetadata field in the Package proto.