Improve documentation on setup

[patcon]

Reticketed from #87 (comment)

After a little stumbling around, I got this working (I use pipenv)

brew install pipenv # for keeping each app in a virtualenv
brew install pyenv # for installing other versions of python
pipenv --version
>>> pipenv, version 2018.10.9
pyenv --version
>>> pyenv 1.2.7
pipenv run python --version
>>> Python 3.6.5
# Install a 3.x version with pyenv if you don't have it
git clone LABHR/octohatrack
cd octohatrack
pipenv run python setup.py install
pipenv run octohatrack
>>> usage: octohatrack [-h] [--no-cache] [--wait-for-reset] [-v] username/repo
>>> octohatrack: error: the following arguments are required: username/repo
pipenv run octohatrack LABHR/octohatrack
>>> Checking repo exists....Repo does not exist: LABHR/octohatrack
export GITHUB_TOKEN=xxxxxxxxxxxxxxxxx
pipenv run octohatrack LABHR/octohatrack
>>> Checking repo exists....
>>> Getting API Contributors................. etc etc working

cc: @Chandler-Song

[glasnt]

Hi @patcon, @Chandler-Song

As an FYI, this project was started back in 2015, before pipenv existed. The style at the time was virtualenv, but the idea is you can run it as a CLI, but local development would be based on your flavour of local development.

I plan to come back to this and give it a huge overhaul, taking into account the new changes to the GitHub API, and putting into practice all I've learnt about Python in the years since I first created this app, but right now I don't have the capacity to maintain the 'beta' version of the application.

I appreciate the time you're taking to help each other out, so this is more of a heads up as a maintainer ✨

[glasnt]

Turns out the major issue here (apart from an underdocumentation of virtual env/pyenv setup info) was an issue where I was presuming a GITHUB_TOKEN. I've fixed that in 2e84313, a fix that will be merged and released shortly.