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

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

Open
ehinman opened this issue Jul 13, 2024 · 3 comments
Open

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

ehinman opened this issue Jul 13, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ehinman
Copy link
Contributor

ehinman commented Jul 13, 2024

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
Copy link
Collaborator

willingc commented Aug 3, 2024

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

@willingc
Copy link
Collaborator

willingc commented Aug 3, 2024

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.

@willingc willingc added the documentation Improvements or additions to documentation label Aug 3, 2024
@lwasser
Copy link
Member

lwasser commented Aug 7, 2024

@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).

@willingc willingc added the good first issue Good for newcomers label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: python programming
Development

No branches or pull requests

3 participants