FreePublicPerlAPIs

List of Perl modules and clients for the web services listed at https://www.freepublicapis.com/. See the initial announcement on r/perl and the follow up post to Perlmonk's Perl News nodelet.

If you think your favorite or personal module, idiom, or paradigm is the best - prove it by creating the best Free Public API Perl module!

Click to See What's Already Been Uploaded to CPAN!

How to participate

1. Claim a Free Public API at the wiki page
2. Create API and client, show casing your skills and favorite idioms/modules
3. Upload to CPAN (if you don't know where, use the Acme::Free::API:: name space!)
4. Update wiki with appropriate links
5. Tell everybody!
6. Discussions are enabled, keep it clean and germane.
7. You also may seek wisdom here or here.

Note: A module is not considered complete until it's been uploaded to CPAN. This is not optional. Effectively this means your project will not be listed on CPAN or at the FreePublicAPI site.

See an example module on CPAN - Acme::Free::API::Ye.

Rules && Guidelines

This is supposed to be easy and fun! This is not a race. It is a marathon.

1. Make sure the API you select at not been claimed
2. Make sure to select an API that is FREE from https://www.freepublicapis.com/ and stronkly recommendated that the API requires NO authentication mechanism (this is a giant PITA for everyone in this kind of effort) - but if you find one that you like and you want to deal with the auth, go for it!
3. A complete entry consists of at least 1 Perl module and 1 commandline client with commands to use all API endpoints
4. You MUST use the Acme::Free::API:: name space on CPAN
5. Complete POD is required. POD is not required, but it must render in perldoc and on MetaCPAN
6. Installing the module must also install the client (so it's available via PATH) and all dependencies.
7. Dist::Zilla is strongly recommended, so please include any dist.ini (see example) in your CPAN upload!
8. ALL endpoints of the API must be implemented and used in some way by the cli client
9. You must claim your API before you start working on it
10. There are no deadlines, but if your claim is clearly stale it can be scooped
11. NO TRIAL module uploaded to CPAN
12. Versions must start at 1.0.0 or very near that if you anticipate some changes
13. Modules must be complete (hence the preference for 1.0.0
14. Modules must have at least 1 test in t/, as trivial as it may be
15. Modules and cli client must be zero conf (no configuration files required)
16. You can use ChatGPT or whatever, but it must be clearly noted that you did this (and to what degree)
17. External code that is not yours used must be attributed
18. All code must be released with the Perl or similar licensing

FAQ

1. Q: Will there be any voting or picking of some kind of winner? A: NO, the proof is in the pudding
2. Q: Is there a main place to discuss this? A: NO
3. Q: Is there a main point of contact for questions or clarifications? A: Best bet is to creat an issue here
4. Q: Who is the final arbiter in any disputes related to this fun thing? A: OODLER - but let's not make it come to that :-)
5. Q: Is this just for Perl5 modules? A: YES
6. Q: Do I have to use the Acme:: name space? A: NO, but if you don't have a good one then use it - the project default is Acme::Free::API::
7. Q: Do I have to use Github? A: Definitely NOT
8. Q: Do I have to use Dist::Zilla? A: NO, but it is recommended since it helps you churn through creating & updating modules on CPAN like butter

GOOD LUCK!