Yanick Champoux > WWW-Ohloh-API-v0.3.2 > WWW::Ohloh::API::ActivityFact

Download:
WWW-Ohloh-API-v0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: v0.3.2   Source  

NAME ^

WWW::Ohloh::API::ActivityFact - collection of statistics about an Ohloh project

SYNOPSIS ^

    use WWW::Ohloh::API;

    my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );
    my $facts =  $ohloh->get_activity_facts( $project_id, $analysis);
    my $fact = $facts->latest;

    print $fact->month, ": ", $fact->contributors;

DESCRIPTION ^

W::O::A::ActivityFact contains monthly statistics about an Ohloh-registered project. To be properly populated, it must be retrieved via a WWW::Ohloh::API::ActivityFacts object.

METHODS ^

API Data Accessors

month

Return the month covered by this activity fact.

code_added, code_removed, comments_added, comments_removed, blanks_added, blanks_removed

Return the number of lines of code/comments/blanks added/removed during this month.

commits

Return the number of commits made during that month.

contributors

Return the number of contributors having made at least one commit during this month.

Other Methods

as_xml

Return the activity fact information as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.

SEE ALSO ^

VERSION ^

This document describes WWW::Ohloh::API version 0.3.2

BUGS AND LIMITATIONS ^

WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.

The as_xml() method returns a re-encoding of the activity fact data, which can differ of the original xml document sent by the Ohloh server.

Please report any bugs or feature requests to bug-www-ohloh-api@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Yanick Champoux <yanick@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2008, Yanick Champoux <yanick@cpan.org>. All rights reserved.

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

syntax highlighting: