Documentation
¶
Overview ¶
Package requirements extracts requirements files.
Index ¶
Constants ¶
View Source
const (
// Name is the unique name of this extractor.
Name = "python/requirements"
)
Variables ¶
This section is empty.
Functions ¶
func New ¶ added in v0.1.2
func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)
New returns a requirements.txt extractor.
Types ¶
type Extractor ¶
Extractor extracts python packages from requirements.txt files.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract extracts packages from requirements files passed through the scan input.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file matches python Metadata file patterns.
func (Extractor) Requirements ¶ added in v0.1.3
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
type Metadata ¶ added in v0.1.2
type Metadata struct {
// The values from the --hash flags, as in https://pip.pypa.io/en/stable/topics/secure-installs/#hash-checking-mode.
// These are the hashes of the distributions of the package.
HashCheckingModeValues []string
// The comparator used to compare the package version, e.g. ==, ~=, >=
VersionComparator string
// The dependency requirement to used for dependency resolution
Requirement string
}
Metadata contains additional information from a package in a requirements file.
func ToStruct ¶ added in v0.4.2
func ToStruct(m *pb.PythonRequirementsMetadata) *Metadata
ToStruct converts the PythonRequirementsMetadata proto to a Metadata struct.
Click to show internal directories.
Click to hide internal directories.