.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "MetaCPAN::Client::Release 3pm"
.TH MetaCPAN::Client::Release 3pm "2018-05-17" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MetaCPAN::Client::Release \- A Release data object
.SH "VERSION"
.IX Header "VERSION"
version 2.025000
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
my \f(CW$release\fR = \f(CW$mcpan\fR\->release('Moose');
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A MetaCPAN release entity object.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "status"
.IX Subsection "status"
The release's status, \f(CW\*(C`latest\*(C'\fR, \f(CW\*(C`cpan\*(C'\fR, or \f(CW\*(C`backpan\*(C'\fR.
.SS "name"
.IX Subsection "name"
The release's name, something like \f(CW\*(C`Moose\*(C'\fR.
.SS "date"
.IX Subsection "date"
An \s-1ISO8601\s0 datetime string like \f(CW\*(C`2016\-11\-19T12:41:46\*(C'\fR indicating when the
release was uploaded.
.SS "author"
.IX Subsection "author"
The \s-1PAUSE ID\s0 of the author who uploaded the release.
.SS "maturity"
.IX Subsection "maturity"
This will be either \f(CW\*(C`released\*(C'\fR or \f(CW\*(C`developer\*(C'\fR.
.SS "main_module"
.IX Subsection "main_module"
The release's main module name.
.SS "id"
.IX Subsection "id"
The release's internal MetaCPAN id.
.SS "authorized"
.IX Subsection "authorized"
A boolean indicating whether or not this was an authorized release.
.SS "download_url"
.IX Subsection "download_url"
A \s-1URL\s0 for this release's distribution archive file.
.SS "first"
.IX Subsection "first"
A boolean indicating whether or not this is the first release of this
distribution.
.SS "archive"
.IX Subsection "archive"
The filename of the archive file for this release.
.SS "version"
.IX Subsection "version"
The release's version.
.SS "version_numified"
.IX Subsection "version_numified"
The numified form of the release's version.
.SS "deprecated"
.IX Subsection "deprecated"
The deprecated field value for this release.
.SS "distribution"
.IX Subsection "distribution"
The name of the distribution to which this release belongs.
.SS "abstract"
.IX Subsection "abstract"
The abstract from this release's metadata.
.SS "dependency"
.IX Subsection "dependency"
This is an arrayref of hashrefs. Each hashref contains the following keys:
.IP "\(bu" 4
phase
.Sp
The phase to which this dependency belongs. This will be one of \f(CW\*(C`configure\*(C'\fR,
\&\f(CW\*(C`build\*(C'\fR, \f(CW\*(C`runtime\*(C'\fR, \f(CW\*(C`test\*(C'\fR, or \f(CW\*(C`develop\*(C'\fR.
.IP "\(bu" 4
relationship
.Sp
This will be one of \f(CW\*(C`requires\*(C'\fR, \f(CW\*(C`recommends\*(C'\fR, or \f(CW\*(C`suggests\*(C'\fR.
.IP "\(bu" 4
module
.Sp
The name of the module which is depended on.
.IP "\(bu" 4
version
.Sp
The required version of the dependency. This may be \f(CW0\fR, indicating that any
version is acceptable.
.SS "license"
.IX Subsection "license"
An arrayref containing the license(s) under which this release has been made
available. These licenses are represented by strings like \f(CW\*(C`perl_5\*(C'\fR or
\&\f(CW\*(C`gpl2\*(C'\fR.
.SS "provides"
.IX Subsection "provides"
This an arrayref containing a list of all the modules provided by this distribution.
.SS "metadata"
.IX Subsection "metadata"
This is a hashref containing metadata provided by the distribution. The exact
contents of this hashref will vary across \s-1CPAN,\s0 but should largely conform to
the spec defined by CPAN::Meta::Spec.
.SS "resources"
.IX Subsection "resources"
The resources portion of the release's metadata, returned as a hashref.
.SS "stat"
.IX Subsection "stat"
A hashref containing \f(CW\*(C`stat()\*(C'\fR all information about the release's archive
file. The keys are:
.IP "\(bu" 4
mtime
.Sp
The Unix epoch of the file's last modified time.
.IP "\(bu" 4
mode
.Sp
The file's mode (as an integer, not an octal representation).
.IP "\(bu" 4
size
.Sp
The file's size in bytes.
.SS "tests"
.IX Subsection "tests"
Returns a hashref of information about \s-1CPAN\s0 testers results for this
release. The keys are \f(CW\*(C`pass\*(C'\fR, \f(CW\*(C`fail\*(C'\fR, \f(CW\*(C`unknown\*(C'\fR, and \f(CW\*(C`na\*(C'\fR. The values are
the count of that particular result on \s-1CPAN\s0 Testers for this release.
.SH "METHODS"
.IX Header "METHODS"
.SS "changes"
.IX Subsection "changes"
Returns the Changes text for the release.
.SS "metacpan_url"
.IX Subsection "metacpan_url"
Returns a link to the release page on MetaCPAN.
.SS "contributors"
.IX Subsection "contributors"
Returns a structure with release contributors info.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Sawyer X <xsawyerx@cpan.org>
.IP "\(bu" 4
Mickey Nasriachi <mickey@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Sawyer X.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.