Top Ranking Issues

[kurt-rhee]

• [ x ] Closes Top Ranking Github Issues #2196 (Though we could keep this open to hold the top ranking issues)
• [ x ] I am familiar with the contributing guidelines
• Tests added
• Updates entries in docs/sphinx/source/reference for API changes.
• Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
• New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
• [ x ] Pull request is nearly complete and ready for detailed review.
• Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

[kurt-rhee]

@AdamRJensen

The pull request here runs a script that ranks the pvlib python github issues by the number of thumbs up. It then edits #2196 to show the ordered list of issues.

A maintainer will need to add a github token as an environment variable and setup a github actions workflow that runs this script on a cron job. It might also be nice to pin issue 2196.

Other than that I think this is ready to go.

[kurt-rhee]

I also think that perhaps I am using a different version of flake8. The linter in the PR says:

But from my perspective I am not seeing any unmatched brackets.

[AdamRJensen]

• I pinned the issue

In regards to the Token, then I don't think we should add one, but rather use the built in GitHub token: https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication

[echedey-ls]

I also think that perhaps I am using a different version of flake8. The linter in the PR says:

But from my perspective I am not seeing any unmatched brackets.

You've probably figured it out already, but I think the problem are the string keys using double quotes, inside a double-quoted f-string. The following line should fix it, note single quotes:

f"{issue._rawData['reactions']['+1']} :thumbsup:"

Edit:
From a quick glance at the code, it looks super intuitive to maintain, I really like it!

[echedey-ls]

I feel like we should exclude the own issue from the list, before, in or after the for loop, wherever it is readable the most.

[kandersolar]

The GH Actions job was set up to try to run on PRs so that we could test everything out here in this PR, but I'm not sure we're going to be able to get that working here. I think maybe the way forward is to get the script to a point where we like the looks of it, then merge, and then see whether it works as expected with the cron job. We can then do a follow-up PR with any fixes as needed.

Also @kurt-rhee, the YAML sets the environment variable GITHUB_ACCESS_TOKEN but the script is now looking for GITHUB_TOKEN. One should change to match the other; up to you which one :)

[kurt-rhee]

@kandersolar woops! I thought that the token had to specifically be named GITHUB_TOKEN I've changed it back to match

[kurt-rhee]

@echedey-ls thank you! And sorry it has been a while since I've worked in python 😳

[kandersolar]

I think we're ready for testing, so I'm going to merge this. @kurt-rhee, @AdamRJensen, and @echedey-ls, let's keep an eye on the pinned issue and the cron job logs and see what we think :)

If nothing else, we'll want to eventually edit the cron job to not run on PRs anymore, and to run less frequently than every 10 minutes.

[AdamRJensen]

Awesome job @kurt-rhee!

Just checked the issue and it works like a charm!