26 Jun 2012 23:02:20 UTC
- Distribution: WWW-Ohloh-API
- Module version: v0.3.2
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (1)
- KwaliteeBus factor: 1
- 92.86% Coverage
- License: perl_5
- Perl: v5.8.0
- Activity24 month
- Download (90.39KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionYANICK Yanick Champoux
- SEE ALSO
- BUGS AND LIMITATIONS
- LICENCE AND COPYRIGHT
WWW::Ohloh::API::SizeFact - statistics about a Project source code
use WWW::Ohloh::API; my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key ); my @size_facts = $ohloh->get_size_facts( $project_id ); my $size_fact = shift @size_facts; print $size_fact->month;
W::O::A::SizeFact contains the statistics associated with an Ohloh project. To be properly populated, it must be created via the
get_size_factsmethod of a WWW::Ohloh::API object.
Indicate the month covered by this SizeFact.
The total net lines of code, excluding comments and blanks, as of the end of this month.
The total net lines of comments as of the end of this month.
The total net blank lines as of the end of this month.
The fraction of net lines which are comments as of the end of this month.
The cumulative total months of effort expended by all contributors on this project, including this month.
( $month, $commits, $code, $blanks, $comments, $comment_ratio, $man_month ) = $size_fact->stats;
Return the facts as an array.
Return the size fact as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.
@stats = @$size_fact; # equivalent to # @stats = $size_fact->stats
Using the object as an array reference can be used as a shortcut for the method stats.
Ohloh API reference: http://www.ohloh.net/api/getting_started
Ohloh size_fact API reference: http://www.ohloh.net/api/reference/size_fact
This document describes WWW::Ohloh::API version 0.3.2
WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.
as_xml()method returns a re-encoding of the account data, which can differ of the original xml document sent by the Ohloh server.
Please report any bugs or feature requests to
firstname.lastname@example.org, or through the web interface at http://rt.cpan.org.
Copyright (c) 2008, Yanick Champoux
<email@example.com>. 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.
Module Install Instructions
To install WWW::Ohloh::API, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install WWW::Ohloh::API
For more information on module installation, please visit the detailed CPAN module installation guide.