NAME

MetaCPAN::Client::Release - A Release data object

VERSION

version 2.031001

SYNOPSIS

my $release = $mcpan->release('Moose');

DESCRIPTION

A MetaCPAN release entity object.

ATTRIBUTES

status

The release's status, latest, cpan, or backpan.

name

The release's name, something like Moose-1.23.

date

An ISO8601 datetime string like 2016-11-19T12:41:46 indicating when the release was uploaded.

author

The PAUSE ID of the author who uploaded the release.

maturity

This will be either released or developer.

main_module

The release's main module name.

id

The release's internal MetaCPAN id.

authorized

A boolean indicating whether or not this was an authorized release.

download_url

A URL for this release's distribution archive file.

checksum_sha256

The sha256 hexdigest for this release's distribution archive file.

checksum_md5

The md5 hexdigest for this release's distribution archive file.

first

A boolean indicating whether or not this is the first release of this distribution.

archive

The filename of the archive file for this release.

version

The release's version.

version_numified

The numified form of the release's version.

deprecated

The deprecated field value for this release.

distribution

The name of the distribution to which this release belongs. Something like Moose

abstract

The abstract from this release's metadata.

dependency

This is an arrayref of hashrefs. Each hashref contains the following keys:

  • phase

    The phase to which this dependency belongs. This will be one of configure, build, runtime, test, or develop.

  • relationship

    This will be one of requires, recommends, or suggests.

  • module

    The name of the module which is depended on.

  • version

    The required version of the dependency. This may be 0, indicating that any version is acceptable.

license

An arrayref containing the license(s) under which this release has been made available. These licenses are represented by strings like perl_5 or gpl2.

provides

This an arrayref containing a list of all the modules provided by this distribution.

metadata

This is a hashref containing metadata provided by the distribution. The exact contents of this hashref will vary across CPAN, but should largely conform to the spec defined by CPAN::Meta::Spec.

resources

The resources portion of the release's metadata, returned as a hashref.

stat

A hashref containing stat() all information about the release's archive file. The keys are:

  • mtime

    The Unix epoch of the file's last modified time.

  • mode

    The file's mode (as an integer, not an octal representation).

  • size

    The file's size in bytes.

tests

Returns a hashref of information about CPAN testers results for this release. The keys are pass, fail, unknown, and na. The values are the count of that particular result on CPAN Testers for this release.

METHODS

changes

Returns the Changes text for the release.

metacpan_url

Returns a link to the release page on MetaCPAN.

contributors

Returns a structure with release contributors info.

AUTHORS

  • Sawyer X <xsawyerx@cpan.org>

  • Mickey Nasriachi <mickey@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Sawyer X.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.