module::cpants::analyse(3pm) [debian man page]

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->unpack;
	   $analyser->analyse;
	   $analyser->calc_kwalitee;
	   # 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.

   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.

       read_meta_yml

       Reads the META.yml file and returns its content.

WEBSITE

       <http://cpants.perl.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 http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-CPANTS-Analyse <http://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: http://lists.perl.org/list/perl-qa.html
       <http://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.14.2							    2012-06-08					      Module::CPANTS::Analyse(3pm)

CPANTS_LINT(1p) 					User Contributed Perl Documentation					   CPANTS_LINT(1p)

NAME

       cpants_lint - commandline frontend to Module::CPANTS::Analyse

SYNOPSIS

	   cpants_lint path/to/Foo-Dist-1.42.tgz

	   Options:
	       --help		   brief help message
	       --man		   full documentation
	       --verbose	   print more info during run
	       --no_capture	   don't turn on capturing of STDERR and STDOUT

	       --dump		   dump result using Data::Dumper
	       --yaml		   dump result as YAML

	       --to_file	   dump result to a file
	       --dir		   directory to dump files to

DESCRIPTION

       "cpants_lint" checks the Kwalitee of CPAN distributions. More exact, it checks how a given tarball will be rated on
       "http://cpants.perl.org", without needing to upload it first.

       "cpants_lint" is also used by "cpants.perl.org" itself to check all dists on CPAN.

       For more information on Kwalitee, and the whole of CPANTS, see "http://cpants.perl.org" and / or "Module::CPANTS::Analyse".

OPTIONS

       If neither "--dump" nor "--yaml" are used, a short text describing the Kwalitee of the distribution and hints on how to raise Kwalitee will
       be displayed. The format of this text can change anytime, so don't use it for any automated processing!

       --help

       Print a brief help message.

       --man

       Print manpage.

       --verbose

       Print some informative messages during testing of dists.

       --no_capture

       Turn off capturing of STDOUT and STDERR. Mostly useful during debugging / development of new features.

       If "--no_capture" is used, the value of "cpants_error" might be wrong.

       --dump

       Dump the result using Data::Dumper

       --yaml

       Dump the result as YAML.

       --to_file

       Output the result into a file instead of STDOUT.

       The name of the file will be Foo-Dist.yaml (well, the extension depends on the dump format and can be ".yaml", ".dump" or ".txt")

       --dir

       Directory to dump files to. Defaults to the current working directory.

AUTHOR

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

COPYRIGHT AND LICENSE

       Copyright X 2003X2006, 2009 Thomas Klausner <https://metacpan.org/author/domm>

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

perl v5.14.2							    2012-06-08							   CPANTS_LINT(1p)