iblancasa / githubspanishrankinggenerator

Scripts to build the GitHub Spanish rankings (users most active in each province sorted by public contributions) :es:

GH-Spanish-Ranking

This repository contains the configuration files to generate the GitHub rankings of Spain.

GitHubCity is used to generate the rankings.

Demo

How to generate the rankings?

IMPORTANT: GitHubCity is not compatible with Python 2. So, this repository will not work with Python 2.

You need to install GitHubCity. You can do directly from pip or running:

pip install -r requirements.txt

Where are the results?

You can find the results in this repository.

License

The MIT License (MIT)

Copyright (c) 2015-2017 Israel Blancas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

githubspanishrankinggenerator's Issues

Add markdown

Create template html

Separate configuration from the generation

If I decide to generate the rankings for a new location different to Spain, I need to copy all the scripts here. If something is improved in the new repository, I will need to copy the improvements here.

For this reason, I this repository will contain the scripts only. A new repository will contain the configuration.

Move from gmake to a "pythonic" system

I would like to use something more... "pythonic".

Could paver be a good choice?

Check if the generated JSON are correct

It would be a good idea to have a way to check if the generated JSON files have a correct format.

Create a rule for Spain

Create a rule to generate Spain: all the cities and the region

Add a CODE_OF_CONDUCT.md file

This repository should have one CODE_OF_CONDUCT.md file

Create all configuration files

SImilar to https://github.com/JJ/github-city-rankings/

Limit Córdoba to Córdoba Spain.

If we want to avoid the people from Córdoba (Argentina), we need to look for Spain in the location. It is the only way.

Fix images - cities

Script to calcule cities

License of data generated?

Create script with all cities

Create template JSON

Travis: Move the generation of the rankings to the deploy

In the script section, only should be tests. The generation of the rankings should be done in the deploy section.

Why?
Because Travis doesn't allow to use the secured variables in a PR. If the GitHub keys are not defined, the test check will fail.

The top in Spain should not limit to 100 the JSON

Add a CONTRIBUTING.md file

It would be nice to have a contributing guide in the repository ✌️

Create a rule to get Spain

Some users added only "Spain" to their location. It would be nice to get all the people who have "Spain" in their profiles.

Update the date

I need to update the date of the config files

Some users from Córdoba (Argentina) are in the ranking

I have to check what users are not from Córdoba Spain and filter them.