NAME

App::ListNewCPANDists - List new CPAN distributions in a given time period

VERSION

This document describes version 0.023 of App::ListNewCPANDists (from Perl distribution App-ListNewCPANDists), released on 2023-03-28.

FUNCTIONS

create_new_cpan_dists_stats

Usage:

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

This function is not exported.

Arguments ('*' denotes required arguments):

  • dists => array

    (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)

list_monthly_new_cpan_dists

Usage:

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

List new CPAN distributions in a given month.

Like list_new_cpan_dists but you only need to specify month and year instead of starting and ending time period.

This function is not exported.

Arguments ('*' denotes required arguments):

  • exclude_author_re => re

    (No description)

  • exclude_authors => array[cpan::pause_id]

    (No description)

  • exclude_dist_re => re

    (No description)

  • exclude_dists => array[perl::distname]

    (No description)

  • include_author_re => re

    (No description)

  • include_authors => array[cpan::pause_id]

    (No description)

  • include_dist_re => re

    (No description)

  • include_dists => array[perl::distname]

    (No description)

  • month* => int

    (No description)

  • year* => int

    (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)

list_monthly_new_cpan_dists_html

Usage:

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

List new CPAN distributions in a given month (HTML format).

Like list_monthly_new_cpan_dists but produces HTML table instead of data structure.

This function is not exported.

Arguments ('*' denotes required arguments):

  • cpan => dirname

    Location of your local CPAN mirror, e.g. /path/to/cpan.

    Defaults to ~/cpan. This actually does not need to be a real CPAN local mirror, but can be just an empty directory. If you use happen to use App::lcpan, you can use the local CPAN mirror generated by lcpan (which also defaults to ~/cpan) to store the database.

  • db_name => filename (default: "index-lncd.db")

    Filename of database.

  • exclude_author_re => re

    (No description)

  • exclude_authors => array[cpan::pause_id]

    (No description)

  • exclude_dist_re => re

    (No description)

  • exclude_dists => array[perl::distname]

    (No description)

  • include_author_re => re

    (No description)

  • include_authors => array[cpan::pause_id]

    (No description)

  • include_dist_re => re

    (No description)

  • include_dists => array[perl::distname]

    (No description)

  • month* => int

    (No description)

  • year* => int

    (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)

list_new_cpan_dists

Usage:

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

List new CPAN distributions in a given time period.

Examples:

  • Show new distributions from Jan 1, 2019 to the present:

    list_new_cpan_dists(from_time => "2019-01-01");
  • Show PERLANCAR's new distributions this year:

    list_new_cpan_dists(include_authors => ["PERLANCAR"], this_year => 1);
  • What are the new releases last month?:

    list_new_cpan_dists(last_month => 1);

This utility queries MetaCPAN to find out what CPAN distributions are new in a given time period (i.e. has their first release made during that time period). This utility also collects the information in a SQLite database which defaults to ~/cpan/index-lncd.db or ~/index-lncd.db if ~/cpan~ does not exist. You can customize the location of the generated SQLite database using the cpan and db_name arguments.

This function is not exported.

Arguments ('*' denotes required arguments):

  • cpan => dirname

    Location of your local CPAN mirror, e.g. /path/to/cpan.

    Defaults to ~/cpan. This actually does not need to be a real CPAN local mirror, but can be just an empty directory. If you use happen to use App::lcpan, you can use the local CPAN mirror generated by lcpan (which also defaults to ~/cpan) to store the database.

  • db_name => filename (default: "index-lncd.db")

    Filename of database.

  • exclude_author_re => re

    (No description)

  • exclude_authors => array[cpan::pause_id]

    (No description)

  • exclude_dist_re => re

    (No description)

  • exclude_dists => array[perl::distname]

    (No description)

  • from_time => date

    (No description)

  • include_author_re => re

    (No description)

  • include_authors => array[cpan::pause_id]

    (No description)

  • include_dist_re => re

    (No description)

  • include_dists => array[perl::distname]

    (No description)

  • last_month => true

    (No description)

  • last_week => true

    Monday is the start of the week.

  • last_year => true

    (No description)

  • this_month => true

    (No description)

  • this_week => true

    Monday is the start of the week.

  • this_year => true

    (No description)

  • to_time => date

    (No description)

  • today => true

    (No description)

  • yesterday => true

    (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)

list_new_cpan_dists_html

Usage:

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

List new CPAN distributions in a given month (HTML format).

Like list_new_cpan_dists but produces HTML table instead of data structure.

This function is not exported.

Arguments ('*' denotes required arguments):

  • cpan => dirname

    Location of your local CPAN mirror, e.g. /path/to/cpan.

    Defaults to ~/cpan. This actually does not need to be a real CPAN local mirror, but can be just an empty directory. If you use happen to use App::lcpan, you can use the local CPAN mirror generated by lcpan (which also defaults to ~/cpan) to store the database.

  • db_name => filename (default: "index-lncd.db")

    Filename of database.

  • exclude_author_re => re

    (No description)

  • exclude_authors => array[cpan::pause_id]

    (No description)

  • exclude_dist_re => re

    (No description)

  • exclude_dists => array[perl::distname]

    (No description)

  • from_time => date

    (No description)

  • include_author_re => re

    (No description)

  • include_authors => array[cpan::pause_id]

    (No description)

  • include_dist_re => re

    (No description)

  • include_dists => array[perl::distname]

    (No description)

  • to_time => date

    (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-ListNewCPANDists.

SOURCE

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

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, 2022, 2021, 2020, 2019, 2018, 2017 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-ListNewCPANDists

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.