/ 
App-CPANStreaks-0.004
River stage one • 1 direct dependent • 1 total dependent
/ App::CPANStreaks

NAME

App::CPANStreaks - Calculate various CPAN streaks

VERSION

This document describes version 0.004 of App::CPANStreaks (from Perl distribution App-CPANStreaks), released on 2023-12-11.

DESCRIPTION

FUNCTIONS

cpan_streaks

Usage:

cpan_streaks(%args) -> [$status_code, $reason, $payload, \%result_meta]

Calculate and display CPAN streaks.

This utility calculates one of various CPAN streaks, e.g. daily-releases to see which authors have the longest streaks of releasing at least one CPAN distribution daily.

The data used to calculate the streaks are CPAN module releases packaged in TableData::Perl::CPAN::Release::Static::GroupedDaily, TableData::Perl::CPAN::Release::Static::GroupedWeekly, and TableData::Perl::CPAN::Release::Static::GroupedMonthly, so make you update those modules first from CPAN. These modules in turn get the data from MetaCPAN API from https://metacpan.org.

See also - http://onceaweek.cjmweb.net (defunct) by CJM. - http://cpan.io/board/once-a/ boards by NEILB.

This function is not exported.

Arguments ('*' denotes required arguments):

  • action* => str (default: "calculate")

    (No description)

  • author => cpan::pause_id

    Only calculate streaks for certain authors.

  • exclude_broken => bool (default: 1)

    (No description)

  • min_len => posint

    (No description)

  • table => str

    (No description)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CPANStreaks.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CPANStreaks.

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CPANStreaks

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.