Skip to content

Small amendments #7

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.

Sign up for GitHub

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

Open
benjaoming wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Small amendments #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87480c9
Add additional notes on running the scripts
benjaoming Jun 10, 2016
8ec151a
Always ignore the secret.py file!
benjaoming Jun 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*pyc
step*json
.venv
secret.py
*log
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Usage

* Create a virtualenv and `pip install -r requirements.pip` inside.
* Copy `secret.py.example` to `secret.py`
* Edit `secret.py` with a `clientID` and `secretID` from your github profile/auth page
* Add your username and password (in clear) to `secret.py`
* Edit `secret.py` with a `clientID` and `secretID` generated via [Github OAuth](https://github.com/settings/applications/new)
* Add your username and password (in clear) to `secret.py`. You have to disable 2-factor authentication for this step to work (remember to re-enable!)
* Launch `./auth.py` and export the `GITHUB_TOKEN` variable as suggested.
* You can now clear/remove `secret.py`
* Launch `step1_search_by_location.py`
* Launch `step2_cleanup_users.py`
* Launch `step3_extend_users.py`
* Launch `step1_search_by_location.py` - Sends a query of different African locations to Github and stores the resulting user info. Takes a couple of minutes.
* Launch `step2_cleanup_users.py` - Cleans up data about users discovers
* Launch `step3_extend_users.py` - This step takes a long time (many hours) since it makes 1 request på user discovered!
* Launch `step4_cleanup_dates.py`
* Launch `step5_export_for_map.py`

Expand Down