gophr_api_keys.md

Gophr needs your help!

Gophr.pm is launching into full alpha this week and we're preparing to have real users in the go community stress test our systems. We need your help to make sure it all goes super smooth.

What is Gophr?

Gophr is an end-to-end package management solution for Go. No manifest or lock file and a fully versioned dependency graph. Simply place the url in your import path and it's automatically fully versioned.

How can you help?

Want to know how you can help? It's easy.

Lend a Github API Token to our system!

One of our main cron services keeps track of vital package metrics and refreshes metadata for packages on Github. These services needs Github API keys to work. The more keys we have the faster it can do it's job and keep our metrics as fresh as possible.

It only ever needs to query public packages, (never private or personal repos), and you can also delete your key at anytime.

Don't I have a limited number of tokens?

There is a soft limit, but you can have quite a few number of keys. (I think about 15 or so?). So it shouldn't be a problem. You are free to create and delete keys as you please.

Won't you be able to mess with my account or personal info if I give you a token?

The short answer is, nope!

You can create any number of github tokens, and they each can have a certain scope for what they are allowed to access. When we ask you to create a github token for us, we only ask that you give us access to public repos and that's it.

Example:

Again we only ever ask that an api token given to use has this particular scope. Which means we'll only be able to query information about public repos on Github.

How do I generate Github API keys?

It's really easy! You just need to go to your Github profile token settings. You should see a a menu to generate tokens.

Then you'll need to define a scope for the new key.

Again we only ever ask that an api token given to use has this particular scope. Which means we'll only be able to query information about public repos on Github.

BAM, done!

You can either DM, email, or slack us the key and we'll integrate it into our system.

slack @Shikkic or @skeswa gophr.pm@gmail.com

Also..

Thank you so much for helping the Gophr Project we really do appreciate it. We will include your name on the readme as a special thank you for supporting us!