/ 
CPAN-WWW-Testers-0.44
River stage zero No dependents
/ CPAN::WWW::Testers

NAME

CPAN::WWW::Testers - Present CPAN Testers data

SYNOPSIS

my $t = CPAN::WWW::Testers->new();
$t->directory($directory);
if($update) { $t->update($update); }
$t->generate;

DESCRIPTION

This distribution generates the CPAN Testers Reports website.

CPAN TESTERS

cpan-testers is a group, that was originaly setup by Graham Barr and Chris Nandor.

The objective of the group is to test as many of the distributions available on CPAN as possible, on as many platforms as possible, with a variety of perl interpreters. The ultimate goal is to improve the portability of the distributions on CPAN, and provide good feedback to the authors.

CPAN Testers began as a mailing list with a web interface (see the NNTP website - http://nntp.x.perl.org/group/perl.cpan.testers/). Leon Brocard began working on extracting metadata for use with the CPANTS, and ended up creating the Reports website. This code now allows you to create and host your very own CPAN Testers website, should you so choose.

Unpack the distribution and look at examples/generate.pl, to understand how the site is generated. If you would like to send patches or report bugs, please use the RT system.

INTERFACE

The Constructor

  • new

    Instatiates the object CPAN::WWW::Testers. Requires a hash of parameters, with 'config' being the only mandatory key. Note that 'config' can be anything that Config::IniFiles accepts for the -file option.

Methods

  • generate

    Reads the local copy of the SQLite database, and creates the alphabetic index, distribution and main index web pages, together with the YAML and RSS pages for each distribution.

  • update

    Given an updates file (pass via the constructor hash), will read through the file and update the requested distritbutions and authors only. This is to enable the update of specific pages, which may have got accidentally missed during a regular generate() call. See the 'bin/cpanreps-verify' program for further details.

Accessor Methods

The following accessor methods are used internally, and fall into two categories. The first provides only read-only

  • directory

    Accessor to set/get the directory where the webpages are to be created.

  • database

    Accessor to set/get the local path to the SQLite database. This used to calculate the size of the compressed and uncompressed files for use on the main index page.

BUGS, PATCHES & FIXES

There are no known bugs at the time of this release. However, if you spot a bug or are experiencing difficulties, that is not explained within the POD documentation, please send bug reports and patches to the RT Queue (see below).

Fixes are dependant upon their severity and my availablity. Should a fix not be forthcoming, please feel free to (politely) remind me.

RT: http://rt.cpan.org/Public/Dist/Display.html?Name=CPAN-WWW-Testers

SEE ALSO

CPAN::WWW::Testers::Generator CPAN::Testers::WWW::Statistics

http://www.cpantesters.org/, http://stats.cpantesters.org/, http://wiki.cpantesters.org/

AUTHOR

Original author:    Leon Brocard <acme@astray.com>   200?-2008
Current maintainer: Barbie       <barbie@cpan.org>   2008-present

COPYRIGHT AND LICENSE

Copyright (C) 2002-2008 Leon Brocard <acme@astray.com>
Copyright (C) 2008-2009 Barbie <barbie@cpan.org>

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