licensing

Documentation

Overview

Package licensing contains methods for working with license specifiers.

Index

• type CondaPackageQualifiers
  • func (q *CondaPackageQualifiers) Append(buf *strings.Builder)
• type License
  • func (lic *License) LicenseRule(pkgName, name build.Expr, version, url *build.StringExpr) build.Expr
  • func (lic *License) NameFromFile(allFiles []License) string
• type LicenseInfo
  • func (info *LicenseInfo) CanonicalizeConda(dir, fallback string, licenseOverrides []string, licenceFile string) error
  • func (info *LicenseInfo) LoadConda(ctx context.Context, dir string) error
  • func (info *LicenseInfo) Rules(pkgName, version, url string) []build.Expr
• type PurlQualifiers

Types

type CondaPackageQualifiers

type CondaPackageQualifiers struct {
	Build   string
	Channel string
	Subdir  string
	Type    string
}

CondaPackageQualifiers stores qualifiers for conda packages.

See https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#conda

func (*CondaPackageQualifiers) Append

func (q *CondaPackageQualifiers) Append(buf *strings.Builder)

type License

type License struct {
	CanonicalId string
	Copyright   string
	File        string
	Kinds       []string
}

func (*License) LicenseRule

func (lic *License) LicenseRule(pkgName, name build.Expr,
	version, url *build.StringExpr) build.Expr

func (*License) NameFromFile

func (lic *License) NameFromFile(allFiles []License) string

type LicenseInfo

type LicenseInfo struct {
	Licenses []License
	Version  string
	Homepage string
	Source   string
	Url      string
	Manifest string
	// pURL metadata
	Qualifiers PurlQualifiers
	Name       string
	// contains filtered or unexported fields
}

func (*LicenseInfo) CanonicalizeConda

func (info *LicenseInfo) CanonicalizeConda(dir, fallback string,
	licenseOverrides []string, licenceFile string) error

func (*LicenseInfo) LoadConda

func (info *LicenseInfo) LoadConda(ctx context.Context, dir string) error

func (*LicenseInfo) Rules

func (info *LicenseInfo) Rules(pkgName,
	version, url string) []build.Expr

type PurlQualifiers

type PurlQualifiers interface {
	Append(buf *strings.Builder)
}

PurlQualifiers provides an interface for supplying source-dependent qualifier information for packages.