Acme-CPANModules
view release on metacpan or search on metacpan
- Add some recommendations.
0.1.9 2021-03-23 Released-By: PERLANCAR; Urgency: medium
- Tweak Abstract.
0.1.8 2021-02-20 Released-By: PERLANCAR; Urgency: medium
- Show 'schema' for feature in example.
0.1.7 2021-01-20 Released-By: PERLANCAR; Urgency: medium
- Introduce per-function benchmark instruction.
0.1.6 2021-01-18 Released-By: PERLANCAR; Urgency: low
- No spec changes.
- No spec changes.
- Tweak formatting of code in example.
0.1.1 2019-11-20 Released-By: PERLANCAR; Urgency: medium
- No spec changes.
- Show examples for entry_features property and entry's features &
bench_* properties.
0.1.0 2018-01-09 Released-By: PERLANCAR
- First release. Created from simplification of Acme::CPANLists.
VERSION
This document describes version 0.1.12 of Acme::CPANModules (from Perl
distribution Acme-CPANModules), released on 2023-11-01.
DESCRIPTION
With the multitude of modules that are available on CPAN, it is
sometimes difficult for a user to choose an appropriate module for a
task or find other modules related in some ways to a module. Various
projects like CPAN Ratings <http://cpanratings.perl.org/> (where users
rate and review a distribution; now no longer accepting new submission)
or MetaCPAN <https://metacpan.org/> (which has a "++" feature where
logged-in users can press a button to "++" a module and the website will
tally the number of "++"'s a distribution has) help to some extent.
There are also various blog posts by Perl programmers which review
modules, e.g. CPAN Module Reviews by Neil Bowers
<http://neilb.org/reviews/>.
Acme::CPANModules is another mechanism to help, to let someone
categorize modules in whatever way she likes.
A related website/online service for "CPAN modules" is coming (when I
# an example module list
{
summary => 'List of my favorite modules', # for recommendation of summary, see Recommendations section
description => <<'_',
(Some longer description, in Markdown format)
This is just a list of my favorite modules.
_
## define features to be used by entries. this can be used to generate a
## feature comparison matrix among the entries.
# entry_features => { # optional
# feature1 => {summary=>'Summary of feature1', schema=>'str*'}, # default schema is 'bool' if not specified
# feature2 => {summary=>'Summary of feature2', ...},
# feature3 => {...},
# feature4 => {...},
# ...
# },
entries => [
{...},
...
],
## specify Bencher scenario properties; "bench_" prefix will be removed
## when creating scenario record. see Bencher for more details.
Data::Dump is my favorite dumping module because it outputs Perl code that
is pretty and readable.
_
# rating => 10, # optional, on a 1-10 scale
# alternate_modules => [...], # if you are reviewing an undesirable module and want to suggest better alternative(s)
# related_modules => ['Data::Dump::Color', 'Data::Dumper'], # if you want to specify related modules that are not listed on the other entries of the same list
## specify which features this entry supports/doesn't support. this can be
## used to generate feature comparison matrix. see
## Acme::CPANModulesUtil::FeatureMatrix.
# features => {
# feature1 => 'foo', # string, value is "foo"
# feature2 => 0, # bool, value is false ("no")
# # since feature3 is not specified for this module, the value is "N/A"
# feature4 => {value=>0, summary=>'Irrelevant because foo bar'}, # bool, value is false. with additional note.
# ...
# },
## specify Bencher scenario participant's properties; "bench_" prefix will
## be removed when creating participant record.
# bench_code => sub { ... }, # or
# bench_code_template => 'Data::Dump::dump(<data>)',
# ...
# list what functions are in the module. currently this is mainly used for
required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2022, 2021, 2019, 2018 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=Acme-CPANModules>
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.
lib/Acme/CPANModules.pm view on Meta::CPAN
This document describes version 0.1.12 of Acme::CPANModules (from Perl distribution Acme-CPANModules), released on 2023-11-01.
=head1 DESCRIPTION
With the multitude of modules that are available on CPAN, it is sometimes
difficult for a user to choose an appropriate module for a task or find other
modules related in some ways to a module. Various projects like L<CPAN
Ratings|http://cpanratings.perl.org/> (where users rate and review a
distribution; now no longer accepting new submission) or
L<MetaCPAN|https://metacpan.org/> (which has a C<++> feature where logged-in
users can press a button to C<++> a module and the website will tally the number
of C<++>'s a distribution has) help to some extent. There are also various blog
posts by Perl programmers which review modules, e.g. L<CPAN Module Reviews by
Neil Bowers|http://neilb.org/reviews/>.
Acme::CPANModules is another mechanism to help, to let someone categorize
modules in whatever way she likes.
A related website/online service for "CPAN modules" is coming (when I eventually
get to it :-), or perhaps when I get some help).
lib/Acme/CPANModules.pm view on Meta::CPAN
# an example module list
{
summary => 'List of my favorite modules', # for recommendation of summary, see Recommendations section
description => <<'_',
(Some longer description, in Markdown format)
This is just a list of my favorite modules.
_
## define features to be used by entries. this can be used to generate a
## feature comparison matrix among the entries.
# entry_features => { # optional
# feature1 => {summary=>'Summary of feature1', schema=>'str*'}, # default schema is 'bool' if not specified
# feature2 => {summary=>'Summary of feature2', ...},
# feature3 => {...},
# feature4 => {...},
# ...
# },
entries => [
{...},
...
],
## specify Bencher scenario properties; "bench_" prefix will be removed
## when creating scenario record. see Bencher for more details.
lib/Acme/CPANModules.pm view on Meta::CPAN
Data::Dump is my favorite dumping module because it outputs Perl code that
is pretty and readable.
_
# rating => 10, # optional, on a 1-10 scale
# alternate_modules => [...], # if you are reviewing an undesirable module and want to suggest better alternative(s)
# related_modules => ['Data::Dump::Color', 'Data::Dumper'], # if you want to specify related modules that are not listed on the other entries of the same list
## specify which features this entry supports/doesn't support. this can be
## used to generate feature comparison matrix. see
## Acme::CPANModulesUtil::FeatureMatrix.
# features => {
# feature1 => 'foo', # string, value is "foo"
# feature2 => 0, # bool, value is false ("no")
# # since feature3 is not specified for this module, the value is "N/A"
# feature4 => {value=>0, summary=>'Irrelevant because foo bar'}, # bool, value is false. with additional note.
# ...
# },
## specify Bencher scenario participant's properties; "bench_" prefix will
## be removed when creating participant record.
# bench_code => sub { ... }, # or
# bench_code_template => 'Data::Dump::dump(<data>)',
# ...
# list what functions are in the module. currently this is mainly used for
lib/Acme/CPANModules.pm view on Meta::CPAN
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2022, 2021, 2019, 2018 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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules>
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.
=cut
( run in 0.277 second using v1.01-cache-2.11-cpan-4d50c553e7e )