Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to fetch kwalitee metrics? #116

Closed
szabgab opened this issue Jun 2, 2023 · 12 comments
Closed

How to fetch kwalitee metrics? #116

szabgab opened this issue Jun 2, 2023 · 12 comments

Comments

@szabgab
Copy link
Contributor

szabgab commented Jun 2, 2023

I could not find this in the docs of MetaCPAN::Client. If it is possible, it would be nice to have an example.

@haarg
Copy link
Member

haarg commented Jun 2, 2023

That information is not included in the API, so the client can't give it to you.

@haarg haarg closed this as completed Jun 2, 2023
@szabgab
Copy link
Contributor Author

szabgab commented Jun 2, 2023

Would it be a good idea to mention this in the POD so others who might look for this will be able to find this information easily? I'd be glad to send a PR.

@oalders
Copy link
Member

oalders commented Jun 2, 2023

Is there an API for Kwalitee metrics that we could get the scores from?

@szabgab
Copy link
Contributor Author

szabgab commented Jun 2, 2023

Oh, I thought it was part of MetaCPAN. I just realized that the kwalitee links on MetaCPAN lead to cpants.cpanauthors.org and the data is not coming from MetaCPAN. My bad. Sorry.

@oalders
Copy link
Member

oalders commented Jun 2, 2023

That clears it up. I was confused. 😄

@szabgab
Copy link
Contributor Author

szabgab commented Jun 2, 2023

If we are talking about this, why is there no (easy) way to get the data from cpants? Was that some refusal or just lack of tuits?

@oalders
Copy link
Member

oalders commented Jun 2, 2023

I don't think we've ever tried to do this. Maybe it's possible? I believe @charsbar would be the person to answer this.

@oalders oalders reopened this Jun 2, 2023
@charsbar
Copy link

charsbar commented Jun 2, 2023

@szabgab

Visit https://api.cpanauthors.org/v5 .

Adding .json at the end of a CPANTS URL would also give you some data but the structure may change at any time.

@szabgab
Copy link
Contributor Author

szabgab commented Jun 4, 2023

@charsbar Thanks, I am working on it. I think I found a few issues with the API and reported them on https://github.com/cpants/www-cpants is that the right place do so?

@szabgab
Copy link
Contributor Author

szabgab commented Jun 5, 2023

I've managed to fetch all the data from CPANTS and display the overall metric on CPAN Digger https://cpan-digger.perlmaven.com/ There were about 1,000 of the 40,000 distributions that returned some error indicating a crash on the server.

@Tux
Copy link

Tux commented Jun 5, 2023

From https://cpants.cpanauthors.org/dist/$dist I can retrieve metrics like coverage and kwalitee, which are not available from https://api.cpanauthors.org/v5/dist/$dist/overview, so I like to see your approach.
I use https://github.com/Tux/Release-Checklist/blob/master/scripts/makewww.pl to generate https://tux.nl/perl.html
To you that might not show as fancy, but I like it better. I'm open to improvements and modernizations content-wise (not presentation-wise). My CI part is outdated

Reading the docs, I'd expect https://api.cpanauthors.org/v5/kwalitee/$dist to return me those metrics, but all I get is errors: {"errors":[{"message":"Expected object - got string.","path":"\/errors\/0"}],"status":400}

@szabgab
Copy link
Contributor Author

szabgab commented Jun 6, 2023

@Tux Thanks for you comment. Your page looks nice.

I am fetching data from https://api.cpanauthors.org/v5/release/$author/$dist/metadata but actually currently I am only interested and only display the core_kwalitee field which, if I understand correctly, is an aggregation of all the kwalitee metrics.
Full source code is at https://github.com/szabgab/CPAN-Digger/

@oalders oalders closed this as completed Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants