search

pyOpenSci / pyosMeta

A package that updates pyOpenSci contributor and package metadata on our website
BSD 3-Clause "New" or "Revised" License
4 stars 17 forks source link

In CONTRIBUTING.md, add more specifics on configuring API token #194

Open ehinman opened 1 month ago

ehinman commented 1 month ago

I am trying to use pyosMeta to contribute to the peer-review-metrics repo, but I would love to see more documentation/specifics on the API token required to use the pyosMeta package. This link is not very helpful for configuring the token. Specifically, it would be nice to know what repository permissions and account permissions are suitable for this project.

willingc commented 2 weeks ago

@lwasser Are you using a token with anything other than read permissions for this repo?

willingc commented 2 weeks ago

Looks like this was covered in https://github.com/pyOpenSci/peer-review-metrics?tab=readme-ov-file#3-configure-your-github-access-token. Let's plan to add this as a section when we create docs for the repo.

lwasser commented 1 week ago

@willingc so @ehinman was working on this in our sprint!! i think we can use the same images / documentation used in the peer-review-metrics repo that you linked to above here!!

we had a few people get confused around tokens. Yes a basic read public repos token should do the trick. because this is all open and public, the token can be on the user's account who wants to access the data. The tokenallows for increased limits when hitting the API (is my understanding).