python

package
v0.1.0-beta.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package python provides a concrete Cataloger implementation for Python ecosystem files (egg, wheel, requirements.txt).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cataloger

type Cataloger struct {
	// contains filtered or unexported fields
}

Cataloger catalogs pkg.WheelPkg, pkg.EggPkg, and pkg.PythonRequirementsPkg Package Types defined in Python ecosystem files.

func New

func New() *Cataloger

New returns a new Python cataloger object.

func (*Cataloger) Catalog

func (a *Cataloger) Catalog(contents map[file.Reference]string) ([]pkg.Package, error)

Catalog returns the Packages indexed from all Python ecosystem files discovered.

func (*Cataloger) Name

func (a *Cataloger) Name() string

Name returns a string that uniquely describes this cataloger.

func (*Cataloger) SelectFiles

func (a *Cataloger) SelectFiles(resolver scope.FileResolver) []file.Reference

SelectFiles returns a set of discovered Python ecosystem files from the user content source.

type PoetryMetadata

type PoetryMetadata struct {
	Packages []PoetryMetadataPackage `toml:"package"`
}

func (PoetryMetadata) Pkgs

func (m PoetryMetadata) Pkgs() []pkg.Package

Pkgs returns all of the packages referenced within the poetry.lock metadata.

type PoetryMetadataPackage

type PoetryMetadataPackage struct {
	Name        string `toml:"name"`
	Version     string `toml:"version"`
	Category    string `toml:"category"`
	Description string `toml:"description"`
	Optional    bool   `toml:"optional"`
}

func (PoetryMetadataPackage) Pkg

Pkg returns the standard `pkg.Package` representation of the package referenced within the poetry.lock metadata.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL