Module::CPANTS::Analyse(3pm)   User Contributed Perl Documentation   Module::CPANTS::Analyse(3pm)



NAME
       Module::CPANTS::Analyse - Generate Kwalitee ratings for a distribution

SYNOPSIS
           use Module::CPANTS::Analyse;

           my $analyser = Module::CPANTS::Analyse->new({
               dist => 'path/to/Foo-Bar-1.42.tgz',
           });
           $analyser->run;
           # results are in $analyser->d;

DESCRIPTION
   Methods
       new

         my $analyser = Module::CPANTS::Analyse->new({dist => 'path/to/file'});

       Plain old constructor.

       unpack

       Unpack the distribution into a temporary directory.

       Returns an error if something went wrong, "undef" if all went well.

       analyse

       Run all analysers (defined in "Module::CPANTS::Kwalitee::*" on the dist.

       calc_kwalitee

       Check if the dist conforms to the Kwalitee indicators.

       run

       Unpacks, analyses, and calculates kwalitee, and returns a resulting stash.

   Helper Methods
       testdir

       Returns the path to the unique temp directory.

       testfile

       Returns the location of the unextracted tarball.

       tarball

       Returns the filename of the tarball.

       x_opts

       Returns a hash reference that holds normalized information set in the "x_cpants" custom
       META field.

WEBSITE
       <https://cpants.cpanauthors.org/>

BUGS
       Please report any bugs or feature requests, or send any patches, to
       "bug-module-cpants-analyse at rt.cpan.org", or through the web interface at
       <https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-CPANTS-Analyse>.  I will be
       notified, and then you'll automatically be notified of progress on your bug as I make
       changes.

AUTHOR
       Thomas Klausner <https://metacpan.org/author/domm>

       Please use the "perl-qa" mailing list for discussing all things CPANTS:
       <https://lists.perl.org/list/perl-qa.html>

       Based on work by Leon Brocard <https://metacpan.org/author/lbrocard> and the original idea
       proposed by Michael G. Schwern <https://metacpan.org/author/schwern>.

LICENSE
       This code is Copyright X 2003X2006 Thomas Klausner <https://metacpan.org/author/domm>.
       All rights reserved.

       You may use and distribute this module according to the same terms that Perl is
       distributed under.



perl v5.20.2                                2023-09-09               Module::CPANTS::Analyse(3pm)