Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

GitHub city ranking creator

Project Description

What is this?

This is a small library which gets all GitHub users given a city. Original idea is Top-GitHub-Users-Data by [@JJ](https://github.com/JJ), an adaptation of top-github-users from [@paulmillr](https://github.com/paulmillr/).

What I can do with this?

This is an amazing Python library to study the GitHub community in a location. You can get all the GitHub users from a given location and obtain some data. For instance, you can generate one ranking like this ranking with the users from Spain (and its provinces).

What I need to run this?

You will need to install Python 3. Python 2 is not supported.

In addition, you will need to get an ID and Secret for a GitHub application, after registering your own application here!.

Dependencies

There is a requirements.txt file included in this repo. Install all dependences with pip install -r requirements.txt.

How to install

There are two options to install this library and its dependencies.

Install from the source code

You need to clone (or download) this repository. Then, go to src folder and run:

python setup.py install

Install from pip

This library is available to be installed using pip.

pip install githubcity

Getting started

You can see one example about how to use this library here.

Basic example

idGH = os.environ.get('GH_ID')
secretGH = os.environ.get('GH_SECRET')
configuration = {
   "excludedLocations": [],
   "excludedUsers": [],
   "intervals": [
       [
           "2008-01-01",
           "2015-12-30"
       ]
   ],
   "last_date": "2015-12-30",
   "locations": [
       "Ceuta"
       ],
   "name": "Ceuta"
       }
ciudad = GitHubCity(idGH, secretGH, configuration)
ciudad.calculateBestIntervals()
ciudad.addFilter("repos", ">1")
ciudad.addFilter("followers", ">1")
ciudad.getCityUsers()

Excluding users

You can generate a JSON file like this (each element is an use

Release History

Release History

This version
History Node

1.0.4

History Node

1.0.1

History Node

0.1.4

History Node

0.01.03

History Node

0.01.02

History Node

0.01.01

History Node

0.01

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
githubcity-1.0.4.tar.gz (10.9 kB) Copy SHA256 Checksum SHA256 Source Dec 6, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting