From ac8e9ed9dfe286f8320601152ae483be20c8a19a Mon Sep 17 00:00:00 2001 From: Nick Humrich Date: Wed, 8 Jun 2016 11:24:29 -0600 Subject: [PATCH] Python3 and pip support This chage is very significant. First, it chages the code so that it can be ran on either python2, or python3. Second it adds support for pip #31 --- .gitignore | 4 + gitfiti.py | 324 +++++++++++++++++++++++++++++------------------------ setup.py | 37 ++++++ 3 files changed, 221 insertions(+), 144 deletions(-) create mode 100755 setup.py diff --git a/.gitignore b/.gitignore index b4d274e087..631b492b15 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,6 @@ *.pyc gitfiti.sh +build/ +dist/ +gitfiti.egg-info/ + diff --git a/gitfiti.py b/gitfiti.py index 4db9d55b8b..1a10eb946d 100755 --- a/gitfiti.py +++ b/gitfiti.py @@ -9,210 +9,240 @@ noun : Carefully crafted graffiti in a github commit history calendar """ - import datetime import math import itertools -import urllib2 import json +# Python 2 and 3 compatibility with urllib +try: # python3 + from urllib.request import urlopen + from urllib.error import HTTPError, URLError +except ImportError: # python2 + from urllib2 import urlopen, HTTPError, URLError + +#Python2/3 compat for input/input +try: + import __builtin__ + input = getattr(__builtin__, 'raw_input') +except (ImportError, AttributeError): + pass + +__version__ = '0.5.0' + TITLE = ''' - _ __ _____ __ _ + _ __ _____ __ _ ____ _(_) /_/ __(_) /_(_) - / __ `/ / __/ /_/ / __/ / - / /_/ / / /_/ __/ / /_/ / - \__, /_/\__/_/ /_/\__/_/ -/____/ + / __ `/ / __/ /_/ / __/ / + / /_/ / / /_/ __/ / /_/ / + \__, /_/\__/_/ /_/\__/_/ +/____/ ''' KITTY = [ -[0,0,0,4,0,0,0,0,4,0,0,0], -[0,0,4,2,4,4,4,4,2,4,0,0], -[0,0,4,2,2,2,2,2,2,4,0,0], -[2,2,4,2,4,2,2,4,2,4,2,2], -[0,0,4,2,2,3,3,2,2,4,0,0], -[2,2,4,2,2,2,2,2,2,4,2,2], -[0,0,0,3,4,4,4,4,3,0,0,0]] + [0, 0, 0, 4, 0, 0, 0, 0, 4, 0, 0, 0], + [0, 0, 4, 2, 4, 4, 4, 4, 2, 4, 0, 0], + [0, 0, 4, 2, 2, 2, 2, 2, 2, 4, 0, 0], + [2, 2, 4, 2, 4, 2, 2, 4, 2, 4, 2, 2], + [0, 0, 4, 2, 2, 3, 3, 2, 2, 4, 0, 0], + [2, 2, 4, 2, 2, 2, 2, 2, 2, 4, 2, 2], + [0, 0, 0, 3, 4, 4, 4, 4, 3, 0, 0, 0]] ONEUP = [ -[0,4,4,4,4,4,4,4,0], -[4,3,2,2,1,2,2,3,4], -[4,2,2,1,1,1,2,2,4], -[4,3,4,4,4,4,4,3,4], -[4,4,1,4,1,4,1,4,4], -[0,4,1,1,1,1,1,4,0], -[0,0,4,4,4,4,4,0,0]] + [0, 4, 4, 4, 4, 4, 4, 4, 0], + [4, 3, 2, 2, 1, 2, 2, 3, 4], + [4, 2, 2, 1, 1, 1, 2, 2, 4], + [4, 3, 4, 4, 4, 4, 4, 3, 4], + [4, 4, 1, 4, 1, 4, 1, 4, 4], + [0, 4, 1, 1, 1, 1, 1, 4, 0], + [0, 0, 4, 4, 4, 4, 4, 0, 0]] ONEUP2 = [ -[0,0,4,4,4,4,4,4,4,0,0], -[0,4,2,2,1,1,1,2,2,4,0], -[4,3,2,2,1,1,1,2,2,3,4], -[4,3,3,4,4,4,4,4,3,3,4], -[0,4,4,1,4,1,4,1,4,4,0], -[0,0,4,1,1,1,1,1,4,0,0], -[0,0,0,4,4,4,4,4,0,0,0]] + [0, 0, 4, 4, 4, 4, 4, 4, 4, 0, 0], + [0, 4, 2, 2, 1, 1, 1, 2, 2, 4, 0], + [4, 3, 2, 2, 1, 1, 1, 2, 2, 3, 4], + [4, 3, 3, 4, 4, 4, 4, 4, 3, 3, 4], + [0, 4, 4, 1, 4, 1, 4, 1, 4, 4, 0], + [0, 0, 4, 1, 1, 1, 1, 1, 4, 0, 0], + [0, 0, 0, 4, 4, 4, 4, 4, 0, 0, 0]] HACKERSCHOOL = [ -[4,4,4,4,4,4], -[4,3,3,3,3,4], -[4,1,3,3,1,4], -[4,3,3,3,3,4], -[4,4,4,4,4,4], -[0,0,4,4,0,0], -[4,4,4,4,4,4]] + [4, 4, 4, 4, 4, 4], + [4, 3, 3, 3, 3, 4], + [4, 1, 3, 3, 1, 4], + [4, 3, 3, 3, 3, 4], + [4, 4, 4, 4, 4, 4], + [0, 0, 4, 4, 0, 0], + [4, 4, 4, 4, 4, 4]] OCTOCAT = [ -[0,0,0,4,0,0,0,4,0], -[0,0,4,4,4,4,4,4,4], -[0,0,4,1,3,3,3,1,4], -[4,0,3,4,3,3,3,4,3], -[0,4,0,0,4,4,4,0,0], -[0,0,4,4,4,4,4,4,4], -[0,0,4,0,4,0,4,0,4]] + [0, 0, 0, 4, 0, 0, 0, 4, 0], + [0, 0, 4, 4, 4, 4, 4, 4, 4], + [0, 0, 4, 1, 3, 3, 3, 1, 4], + [4, 0, 3, 4, 3, 3, 3, 4, 3], + [0, 4, 0, 0, 4, 4, 4, 0, 0], + [0, 0, 4, 4, 4, 4, 4, 4, 4], + [0, 0, 4, 0, 4, 0, 4, 0, 4]] OCTOCAT2 = [ -[0,0,4,0,0,4,0], -[0,4,4,4,4,4,4], -[0,4,1,3,3,1,4], -[0,4,4,4,4,4,4], -[4,0,0,4,4,0,0], -[0,4,4,4,4,4,0], -[0,0,0,4,4,4,0]] + [0, 0, 4, 0, 0, 4, 0], + [0, 4, 4, 4, 4, 4, 4], + [0, 4, 1, 3, 3, 1, 4], + [0, 4, 4, 4, 4, 4, 4], + [4, 0, 0, 4, 4, 0, 0], + [0, 4, 4, 4, 4, 4, 0], + [0, 0, 0, 4, 4, 4, 0]] HELLO = [ -[0,1,0,0,0,0,0,0,0,1,0,1,0,0,0,0,0,4], -[0,2,0,0,0,0,0,0,0,2,0,2,0,0,0,0,0,4], -[0,3,3,3,0,2,3,3,0,3,0,3,0,1,3,1,0,3], -[0,4,0,4,0,4,0,4,0,4,0,4,0,4,0,4,0,3], -[0,3,0,3,0,3,3,3,0,3,0,3,0,3,0,3,0,2], -[0,2,0,2,0,2,0,0,0,2,0,2,0,2,0,2,0,0], -[0,1,0,1,0,1,1,1,0,1,0,1,0,1,1,1,0,4]] + [0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0, 0, 4], + [0, 2, 0, 0, 0, 0, 0, 0, 0, 2, 0, 2, 0, 0, 0, 0, 0, 4], + [0, 3, 3, 3, 0, 2, 3, 3, 0, 3, 0, 3, 0, 1, 3, 1, 0, 3], + [0, 4, 0, 4, 0, 4, 0, 4, 0, 4, 0, 4, 0, 4, 0, 4, 0, 3], + [0, 3, 0, 3, 0, 3, 3, 3, 0, 3, 0, 3, 0, 3, 0, 3, 0, 2], + [0, 2, 0, 2, 0, 2, 0, 0, 0, 2, 0, 2, 0, 2, 0, 2, 0, 0], + [0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 4]] HIREME = [ -[1,0,0,0,4,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], -[2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], -[3,3,3,0,2,0,3,3,3,0,2,3,3,0,0,3,3,0,3,0,0,2,3,3], -[4,0,4,0,4,0,4,0,0,0,4,0,4,0,0,4,0,4,0,4,0,4,0,4], -[3,0,3,0,3,0,3,0,0,0,3,3,3,0,0,3,0,3,0,3,0,3,3,3], -[2,0,2,0,2,0,2,0,0,0,2,0,0,0,0,2,0,2,0,2,0,2,0,0], -[1,0,1,0,1,0,1,0,0,0,1,1,1,0,0,1,0,1,0,1,0,1,1,1]] + [1, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], + [2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], + [3, 3, 3, 0, 2, 0, 3, 3, 3, 0, 2, 3, 3, 0, 0, 3, 3, 0, 3, 0, 0, 2, 3, 3], + [4, 0, 4, 0, 4, 0, 4, 0, 0, 0, 4, 0, 4, 0, 0, 4, 0, 4, 0, 4, 0, 4, 0, 4], + [3, 0, 3, 0, 3, 0, 3, 0, 0, 0, 3, 3, 3, 0, 0, 3, 0, 3, 0, 3, 0, 3, 3, 3], + [2, 0, 2, 0, 2, 0, 2, 0, 0, 0, 2, 0, 0, 0, 0, 2, 0, 2, 0, 2, 0, 2, 0, 0], + [1, 0, 1, 0, 1, 0, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1]] ASCII_TO_NUMBER = { - '-': 0, - '_': 1, - '~': 2, - '=': 3, - '*': 4 + '-': 0, + '_': 1, + '~': 2, + '=': 3, + '*': 4 } + def str_to_sprite(content): # Break out lines and filter any excess lines = content.split('\n') + def is_empty_line(line): return len(line) != 0 + lines = filter(is_empty_line, lines) + # Break up lines into each character split_lines = map(list, lines) + # Replace each character with its numeric equivalent for line in split_lines: for index, char in enumerate(line): line[index] = ASCII_TO_NUMBER.get(char, 0) + # Return the formatted str return split_lines + ONEUP_STR = str_to_sprite(""" - ******* + ******* *=~~-~~=* *~~---~~* *=*****=* **-*-*-** - *-----* - ***** + *-----* + ***** """) IMAGES = { -'kitty': KITTY, -'oneup':ONEUP, -'oneup2':ONEUP2, -'hackerschool':HACKERSCHOOL, -'octocat':OCTOCAT, -'octocat2':OCTOCAT2, -'hello':HELLO, -'hireme':HIREME, -'oneup_str':ONEUP_STR + 'kitty': KITTY, + 'oneup': ONEUP, + 'oneup2': ONEUP2, + 'hackerschool': HACKERSCHOOL, + 'octocat': OCTOCAT, + 'octocat2': OCTOCAT2, + 'hello': HELLO, + 'hireme': HIREME, + 'oneup_str': ONEUP_STR } + def load_images(img_names): """loads user images from given file(s)""" if img_names[0] == '': return dict() + for image_name in img_names: img = open(image_name) loaded_imgs = {} img_list = '' - img_line = ' ' name = img.readline().replace('\n', '') name = name[1:] while True: img_line = img.readline() + if img_line == '': break img_line.replace('\n', '') - if(img_line[0] == ':'): + + if img_line[0] == ':': loaded_imgs[name] = json.loads(img_list) name = img_line[1:] img_list = '' else: img_list += img_line + loaded_imgs[name] = json.loads(img_list) return loaded_imgs + def get_calendar(username, base_url='https://github.com/'): """retrieves the github commit calendar data for a username""" base_url = base_url + 'users/' + username - try: + try: url = base_url + '/contributions' - page = urllib2.urlopen(url) - except (urllib2.HTTPError,urllib2.URLError) as e: - print ("There was a problem fetching data from {0}".format(url)) - print (e) + page = urlopen(url) + except (HTTPError, URLError) as e: + print("There was a problem fetching data from {0}".format(url)) + print(e) raise SystemExit return page.readlines() + def max_commits(input): """finds the highest number of commits in one day""" output = set() for line in input: for day in line.split(): - if "data-count=" in day: - commit = day.split('=')[1] - commit = commit.strip('"') + if b'data-count=' in day: + commit = day.split(b'=')[1] + commit = commit.strip(b'"') output.add(int(commit)) output = list(output) output.sort() output.reverse() return output[0] + def multiplier(max_commits): """calculates a multiplier to scale github colors to commit history""" - m = max_commits/4.0 + m = max_commits / 4.0 if m == 0: return 1 m = math.ceil(m) m = int(m) return m + def get_start_date(): """returns a datetime object for the first sunday after one year ago today at 12:00 noon""" d = datetime.datetime.today() - date = datetime.datetime(d.year-1, d.month, d.day, 12) + date = datetime.datetime(d.year - 1, d.month, d.day, 12) weekday = datetime.datetime.weekday(date) while weekday < 6: date = date + datetime.timedelta(1) weekday = datetime.datetime.weekday(date) return date + def date_gen(start_date, offset=0): """generator that returns the next date, requires a datetime object as input. The offset is in weeks""" @@ -220,111 +250,117 @@ def date_gen(start_date, offset=0): for i in itertools.count(start): yield start_date + datetime.timedelta(i) + def values_in_date_order(image, multiplier=1): height = 7 width = len(image[0]) for w in range(width): for h in range(height): - yield image[h][w]*multiplier + yield image[h][w] * multiplier + def commit(content, commitdate): template = ("""echo {0} >> gitfiti\n""" - """GIT_AUTHOR_DATE={1} GIT_COMMITTER_DATE={2} """ - """git commit -a -m "gitfiti" > /dev/null\n""") - return template.format(content, commitdate.isoformat(), - commitdate.isoformat()) + """GIT_AUTHOR_DATE={1} GIT_COMMITTER_DATE={2} """ + """git commit -a -m "gitfiti" > /dev/null\n""") + return template.format(content, commitdate.isoformat(), + commitdate.isoformat()) + def fake_it(image, start_date, username, repo, offset=0, multiplier=1, - git_url='git@github.com'): + git_url='git@github.com'): template = ('#!/bin/bash\n' - 'REPO={0}\n' - 'git init $REPO\n' - 'cd $REPO\n' - 'touch README.md\n' - 'git add README.md\n' - 'touch gitfiti\n' - 'git add gitfiti\n' - '{1}\n' - 'git remote add origin {2}:{3}/$REPO.git\n' - 'git pull\n' - 'git push -u origin master\n') + 'REPO={0}\n' + 'git init $REPO\n' + 'cd $REPO\n' + 'touch README.md\n' + 'git add README.md\n' + 'touch gitfiti\n' + 'git add gitfiti\n' + '{1}\n' + 'git remote add origin {2}:{3}/$REPO.git\n' + 'git pull\n' + 'git push -u origin master\n') strings = [] for value, date in zip(values_in_date_order(image, multiplier), - date_gen(start_date, offset)): + date_gen(start_date, offset)): for i in range(value): strings.append(commit(i, date)) return template.format(repo, "".join(strings), git_url, username) + def save(output, filename): """Saves the list to a given filename""" f = open(filename, "w") f.write(output) f.close() + def main(): - print (TITLE) - print ("Enter github url") - ghe = raw_input("Enter nothing for https://github.com/ to be used: ") - print ('Enter your github username:') - username = raw_input(">") + print(TITLE) + print("Enter github url") + ghe = input("Enter nothing for https://github.com/ to be used: ") + print('Enter your github username:') + username = input(">") if not ghe: git_base = "https://github.com/" cal = get_calendar(username) else: - cal = get_calendar(username,base_url=ghe) + cal = get_calendar(username, base_url=ghe) git_base = ghe m = multiplier(max_commits(cal)) - print ('Enter name of the repo to be used by gitfiti:') - repo = raw_input(">") + print('Enter name of the repo to be used by gitfiti:') + repo = input(">") - print ('Enter the number of weeks to offset the image (from the left):') - offset = raw_input(">") + print('Enter the number of weeks to offset the image (from the left):') + offset = input(">") if not offset.strip(): offset = 0 else: offset = int(offset) - print ('By default gitfiti.py matches the darkest pixel to the highest\n' - 'number of commits found in your github commit/activity calendar,\n' - '\n' - 'Currently this is : {0} commits\n' - '\n' - 'Enter the word "gitfiti" to exceed your max\n' - '(this option generates WAY more commits)\n' - 'Any other input will cause the default matching behavior' - ).format(max_commits(cal)) - match = raw_input(">") - if match == "gitfiti": + print('By default gitfiti.py matches the darkest pixel to the highest\n' + 'number of commits found in your github commit/activity calendar,\n' + '\n' + 'Currently this is : {0} commits\n' + '\n' + 'Enter the word "gitfiti" to exceed your max\n' + '(this option generates WAY more commits)\n' + 'Any other input will cause the default matching behavior' + .format(max_commits(cal))) + match = input(">") + if match == "gitfiti": match = m - else: + else: match = 1 - print ('enter file(s) to load images from (blank if not applicable)') - img_names = raw_input(">").split(' ') + print('enter file(s) to load images from (blank if not applicable)') + img_names = input(">").split(' ') images = dict(IMAGES, **load_images(img_names)) - print ('enter the image name to gitfiti') - print ('images: ' + ", ".join(images.keys())) - image = raw_input(">") + print('enter the image name to gitfiti') + print('images: ' + ", ".join(images.keys())) + image = input(">") if not image: image = IMAGES['kitty'] else: - try: + try: image = images[image] - except: + except: image = IMAGES['kitty'] if not ghe: output = fake_it(image, get_start_date(), username, repo, offset, - m*match) + m * match) else: - git_url = raw_input("Enter git url like git@site.github.com: ") + git_url = input("Enter git url like git@site.github.com: ") output = fake_it(image, get_start_date(), username, repo, offset, - m*match,git_url=git_url) + m * match, git_url=git_url) save(output, 'gitfiti.sh') - print ('gitfiti.sh saved.') - print ('Create a new(!) repo at: {0}new and run it.'.format(git_base)) + print('gitfiti.sh saved.') + print('Create a new(!) repo at: {0}new and run it.'.format(git_base)) + if __name__ == '__main__': main() diff --git a/setup.py b/setup.py new file mode 100755 index 0000000000..ab39c1f623 --- /dev/null +++ b/setup.py @@ -0,0 +1,37 @@ +#!/usr/bin/env python +from setuptools import setup, find_packages + +import gitfiti + +requires = [] + +setup_options = dict( + name='gitfiti', + version=gitfiti.__version__, + description='Carefully crafted graffiti in a github commit history calendar.', + long_description='See docs at https://github.com/gelstudios/gitfiti', + author='gelstudios', + author_email='', + url='https://github.com/gelstudios/gitfiti', + packages=find_packages('.'), + package_dir={'gitfiti': 'gitfiti'}, + install_requires=requires, + license="MIT", + classifiers=[ + 'Development Status :: 4 - Beta', + 'Intended Audience :: Developers', + 'Natural Language :: English', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.5', + ], + entry_points={ + 'console_scripts': [ + 'gitfiti=gitfiti.gitfiti:main' + ] + } +) + +setup(**setup_options)