pypi

README

PyPI Feed

This feed allows polling of package updates from the PyPI package repository.

Configuration options

The packages Field can be supplied to the PyPI feed options to enable polling of package specific apis. This is less effective with large lists of packages as it polls the RSS feed for each package individually, but it is much less likely to miss package updates between polling.

feeds:
- type: pypi
  options:
    packages:
    - numpy
    - scipy

PyPI Artifacts Feed

This feed allows polling of PyPI package updates using the XML-RPC feed. This feed contains extra information compared to the other PyPI feed in this project. In particular, this avoids missing upstream notifications when platform-specific archives are uploaded for a package some time after the release was made. Furthermore, the artifact_id field in the output JSON schema is populated with the filename of the release tarball.

Configuration

No configuration; all package updates are monitored. In particular, FeedOptions.Packages is not supported

feeds:
- type: pypi-v2

Documentation

Index

• Constants
• type ArtifactFeed
  • func NewArtifactFeed(feedOptions feeds.FeedOptions) (*ArtifactFeed, error)
  • func (feed ArtifactFeed) GetFeedOptions() feeds.FeedOptions
  • func (feed ArtifactFeed) GetName() string
  • func (feed ArtifactFeed) Latest(cutoff time.Time) ([]*feeds.Package, time.Time, []error)
• type Feed
  • func New(feedOptions feeds.FeedOptions, eventHandler *events.Handler) (*Feed, error)
  • func (feed Feed) GetFeedOptions() feeds.FeedOptions
  • func (feed Feed) GetName() string
  • func (feed Feed) GetPackageList() *[]string
  • func (feed Feed) Latest(cutoff time.Time) ([]*feeds.Package, time.Time, []error)
• type Package
  • func (p *Package) Name() (string, error)
  • func (p *Package) Version() (string, error)
• type Response

Constants

const (
	ArtifactFeedName = "pypi-artifacts"
)

const (
	FeedName = "pypi"
)

Types

type ArtifactFeed

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

func NewArtifactFeed

func NewArtifactFeed(feedOptions feeds.FeedOptions) (*ArtifactFeed, error)

func (ArtifactFeed) GetFeedOptions

func (feed ArtifactFeed) GetFeedOptions() feeds.FeedOptions

func (ArtifactFeed) GetName

func (feed ArtifactFeed) GetName() string

func (ArtifactFeed) Latest

func (feed ArtifactFeed) Latest(cutoff time.Time) ([]*feeds.Package, time.Time, []error)

type Feed

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

func New

func New(feedOptions feeds.FeedOptions, eventHandler *events.Handler) (*Feed, error)

func (Feed) GetFeedOptions

func (feed Feed) GetFeedOptions() feeds.FeedOptions

func (Feed) GetName

func (feed Feed) GetName() string

func (Feed) GetPackageList

func (feed Feed) GetPackageList() *[]string

func (Feed) Latest

func (feed Feed) Latest(cutoff time.Time) ([]*feeds.Package, time.Time, []error)

type Package

type Package struct {
	Title       string      `xml:"title"`
	CreatedDate rfc1123Time `xml:"pubDate"`
	Link        string      `xml:"link"`
}

func (*Package) Name

func (p *Package) Name() (string, error)

func (*Package) Version

func (p *Package) Version() (string, error)

type Response

type Response struct {
	Packages []*Package `xml:"channel>item"`
}