con / tributors

Pay tribute to your contributors! A tool to automatically update contributor files.
https://con.github.io/tributors/
Apache License 2.0
13 stars 5 forks source link

More information on when interaction with external service fails + offline mode? #29

Closed yarikoptic closed 4 years ago

yarikoptic commented 4 years ago
$> vim .tributors  # provided a full name for a person

and expected update to just update "name", but it seems did go for a full "interaction":

$> tributors update zenodo
INFO:zenodo:Updating .zenodo.json
Response 403: rate limit exceeded, cannot retrieve contributors.
  1. would be nice to report which service failed... if we even "hard code" some information about most common gotchas and inform user here ("rate limit on communication with X exceeded. There should be only up to Y interactions. To increase the limit you need to obtain an API key Z from A, or just wait B and rerun again.
  2. update should get an option to perform only offline updates (like here)
vsoch commented 4 years ago

That is always the GitHub API, and there is a note about it in the docs but we could add a note that it's the GitHub api in the error message.

yarikoptic commented 4 years ago

Good docs are great, but IMHO informative --help and error messages are a better guidance. Take git as an example (although indeed it's man pages are now not that easy to digest due to age/richness of functionality - it is then when additional distilled docs/blogs/demos come handy).

vsoch commented 4 years ago

Two fixes here:

The feature you will want for this "offline" mode is to update explicitly from one to another, and .tributors can be a source for the update. Closing here in favor of this issue #32