App::MetaCPANUtils - CLI utilities related to MetaCPAN
This document describes version 0.007 of App::MetaCPANUtils (from Perl distribution App-MetaCPANUtils), released on 2023-01-15.
This distribution contains CLI utilities related to MetaCPAN:
diff-metacpan-releases
download-metacpan-release
list-metacpan-distribution-versions
list-metacpan-distributions
list-metacpan-releases
list-recent-metacpan-releases
open-metacpan-dist-page
open-metacpan-module-page
Usage:
diff_metacpan_releases(%args) -> [$status_code, $reason, $payload, \%result_meta]
Diff two release tarballs.
Examples:
What changed between App-orgadb 0.014 and 0.015?:
diff_metacpan_releases(distribution => "App-orgadb", version1 => 0.014, version2 => 0.015);
What changed in the latest version of App-orgadb?:
diff_metacpan_releases( distribution => "App-orgadb", version1 => "latest-1", version2 => "latest" );
This function is not exported.
Arguments ('*' denotes required arguments):
distribution* => perl::distname
(No description)
version1* => perl::module::release::version
version2* => perl::module::release::version
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)
download_metacpan_release(%args) -> [$status_code, $reason, $payload, \%result_meta]
Download a release to the current directory.
Download latest release of App-orgadb distribution:
download_metacpan_release(distribution => "App-orgadb");
Download the second latest release of App-orgadb distribution:
download_metacpan_release(distribution => "App-orgadb", version => "latest-1");
Uses HTTP::Tiny::Plugin so you can customize download behavior using e.g. HTTP_TINY_PLUGINS environment variable.
HTTP_TINY_PLUGINS
overwrite => true
Whether to overwrite existing downloaded file.
version => perl::module::release::version
If unspecified, will select the latest release.
list_metacpan_distribution_versions(%args) -> [$status_code, $reason, $payload, \%result_meta]
List all versions of a distribution.
The versions will be sorted in a descending order.
list_metacpan_distributions(%args) -> [$status_code, $reason, $payload, \%result_meta]
author => cpan::pause_id
fields => array[str] (default: ["distribution"])
sort => str (default: "distribution")
list_metacpan_modules(%args) -> [$status_code, $reason, $payload, \%result_meta]
fields => array[str] (default: ["module","date","author","status","maturity","version","release","abstract"])
from_date => date
sort => str (default: "module")
status => str (default: "latest")
to_date => date
list_metacpan_releases(%args) -> [$status_code, $reason, $payload, \%result_meta]
date => date
Select a single day, alternative to `from_date` + `to_date`.
distribution => cpan::distname
fields => array[str] (default: ["release","date","author","status","maturity","version","first","distribution","abstract"])
first => bool
sort => str (default: "-date")
status => str
list_recent_metacpan_releases(%args) -> [$status_code, $reason, $payload, \%result_meta]
n => posint
open_metacpan_dist_page(%args) -> [$status_code, $reason, $payload, \%result_meta]
open_metacpan_module_page(%args) -> [$status_code, $reason, $payload, \%result_meta]
module* => perl::modname
If set to true, will log the API result at the trace level.
trace
Please visit the project's homepage at https://metacpan.org/release/App-MetaCPANUtils.
Source repository is at https://github.com/perlancar/perl-App-MetaCPANUtils.
https://metacpan.org
Other distributions providing CLIs for MetaCPAN: MetaCPAN::Clients, App::metacpansearch.
MetaCPAN API Client: MetaCPAN::Client
this-mod-on-metacpan, this-dist-on-metacpan from App::ThisDist::OnMetaCPAN.
perlancar <perlancar@cpan.org>
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.
This software is copyright (c) 2023, 2022, 2021, 2020 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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-MetaCPANUtils
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.
To install App::MetaCPANUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::MetaCPANUtils
CPAN shell
perl -MCPAN -e shell install App::MetaCPANUtils
For more information on module installation, please visit the detailed CPAN module installation guide.