├── src ├── __init__.py └── main.py ├── tests └── __init__.py ├── resources ├── one-user.png ├── heatwave-red.png ├── all-users-1-year.png ├── all-users-3-years.png └── one-user-numbers.png ├── requirements.txt ├── heatwave-complete.sh ├── setup.py ├── .gitignore ├── README.md └── LICENSE /src/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /resources/one-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/james-stoup/heatwave/HEAD/resources/one-user.png -------------------------------------------------------------------------------- /resources/heatwave-red.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/james-stoup/heatwave/HEAD/resources/heatwave-red.png -------------------------------------------------------------------------------- /resources/all-users-1-year.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/james-stoup/heatwave/HEAD/resources/all-users-1-year.png -------------------------------------------------------------------------------- /resources/all-users-3-years.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/james-stoup/heatwave/HEAD/resources/all-users-3-years.png -------------------------------------------------------------------------------- /resources/one-user-numbers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/james-stoup/heatwave/HEAD/resources/one-user-numbers.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | appdirs==1.4.3 2 | attrs==19.1.0 3 | black==19.3b0 4 | black-magic==0.0.12 5 | black-percentage-tester==0.0.3 6 | Click==7.0 7 | colorama==0.4.1 8 | gitdb2==2.0.5 9 | GitPython==2.1.11 10 | isort==4.3.17 11 | MonthDelta==0.9.1 12 | smmap2==2.0.5 13 | toml==0.10.0 14 | -------------------------------------------------------------------------------- /heatwave-complete.sh: -------------------------------------------------------------------------------- 1 | _heatwave_completion() { 2 | local IFS=$' 3 | ' 4 | COMPREPLY=( $( env COMP_WORDS="${COMP_WORDS[*]}" \ 5 | COMP_CWORD=$COMP_CWORD \ 6 | _HEATWAVE_COMPLETE=complete $1 ) ) 7 | return 0 8 | } 9 | 10 | _heatwave_completionetup() { 11 | local COMPLETION_OPTIONS="" 12 | local BASH_VERSION_ARR=(${BASH_VERSION//./ }) 13 | # Only BASH version 4.4 and later have the nosort option. 14 | if [ ${BASH_VERSION_ARR[0]} -gt 4 ] || ([ ${BASH_VERSION_ARR[0]} -eq 4 ] && [ ${BASH_VERSION_ARR[1]} -ge 4 ]); then 15 | COMPLETION_OPTIONS="-o nosort" 16 | fi 17 | 18 | complete $COMPLETION_OPTIONS -F _heatwave_completion heatwave 19 | } 20 | 21 | _heatwave_completionetup; 22 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup, find_packages 3 | 4 | 5 | def read(fname): 6 | return open(os.path.join(os.path.dirname(__file__), fname)).read() 7 | 8 | 9 | setup( 10 | name="heatwave", 11 | version="1.2.1", 12 | description=("A way of visualizing a heat map of a git repo"), 13 | long_description=read("README.md"), 14 | long_description_content_type="text/markdown", 15 | url="https://github.com/james-stoup/heatwave", 16 | author="James Stoup", 17 | author_email="james.r.stoup@gmail.com", 18 | keywords="git visualize heatmap", 19 | license="GNU General Public License v3.0", 20 | packages=find_packages(), 21 | python_requires=">=3.7", 22 | install_requires=["Click", "MonthDelta", "GitPython"], 23 | entry_points={"console_scripts": ["heatwave=src.main:cli"]}, 24 | ) 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | 53 | # Translations 54 | *.mo 55 | *.pot 56 | 57 | # Django stuff: 58 | *.log 59 | local_settings.py 60 | db.sqlite3 61 | 62 | # Flask stuff: 63 | instance/ 64 | .webassets-cache 65 | 66 | # Scrapy stuff: 67 | .scrapy 68 | 69 | # Sphinx documentation 70 | docs/_build/ 71 | 72 | # PyBuilder 73 | target/ 74 | 75 | # Jupyter Notebook 76 | .ipynb_checkpoints 77 | 78 | # IPython 79 | profile_default/ 80 | ipython_config.py 81 | 82 | # pyenv 83 | .python-version 84 | 85 | # pipenv 86 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 87 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 88 | # having no cross-platform support, pipenv may install dependencies that don’t work, or not 89 | # install all needed dependencies. 90 | #Pipfile.lock 91 | 92 | # celery beat schedule file 93 | celerybeat-schedule 94 | 95 | # SageMath parsed files 96 | *.sage.py 97 | 98 | # Environments 99 | .env 100 | .venv 101 | env/ 102 | venv/ 103 | ENV/ 104 | env.bak/ 105 | venv.bak/ 106 | 107 | # Spyder project settings 108 | .spyderproject 109 | .spyproject 110 | 111 | # Rope project settings 112 | .ropeproject 113 | 114 | # mkdocs documentation 115 | /site 116 | 117 | # mypy 118 | .mypy_cache/ 119 | .dmypy.json 120 | dmypy.json 121 | 122 | # Pyre type checker 123 | .pyre/ 124 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![License](http://img.shields.io/:license-gpl3-blue.svg?style=flat-square)](http://www.gnu.org/licenses/gpl-3.0.html) 2 | 3 | # Heatwave 4 | A tool for displaying a visual representation of your git history. 5 | 6 | Heatwave generates a heat map of your git commits, similar to how GitHub's heat map looks. View all commits or a single user's commits for the past year or previous years. Now in stylish red and green colors it makes the perfect Christmas gift. 7 | 8 | Behold the beauty of command line graphics! 9 | 10 | ![Wicked Cool Graphic!](https://github.com/james-stoup/heatwave/blob/master/resources/heatwave-red.png) 11 | 12 | 13 | ## Dependencies 14 | You will probably need to install an environment tool to manage different version of pythons. After you are on Python 3.7+ then install Pip to most easily install heatwave. 15 | 16 | [Install PyEnv first](https://github.com/pyenv/pyenv-installer "PyEnv") 17 | 18 | [Install Pip second](https://pip.pypa.io/en/stable/installing/ "Pip") 19 | 20 | 21 | ## Installation 22 | I always vote for the easy way, but do what you want I guess... 23 | 24 | ### Recommend Way 25 | The fastest way to install heatwave is with pip. 26 | 27 | ```pip install heatwave``` 28 | 29 | ### Manual Way 30 | 31 | To install this manually clone this repo and then install the dependencies using pip: 32 | 33 | ``` 34 | git clone https://github.com/james-stoup/heatwave.git 35 | cd heatwave 36 | pip install -r requirements.txt 37 | ``` 38 | 39 | 40 | ## Usage 41 | 42 | ### View All Committers 43 | View repo stats for all committers: 44 | 45 | ``` 46 | $ heatwave /path/to/my/repo -a 47 | ``` 48 | 49 | ![All Commits](https://github.com/james-stoup/heatwave/blob/master/resources/all-users-1-year.png) 50 | 51 | 52 | ### View All Committers For Several Years 53 | View 3 years worth of commits: 54 | 55 | ``` 56 | $ heatwave /path/to/my/repo -a -y 3 57 | ``` 58 | 59 | ![3 Years of Committs](https://github.com/james-stoup/heatwave/blob/master/resources/all-users-3-years.png) 60 | 61 | 62 | ### View A Specific Committer 63 | View stats on a particular committer: 64 | 65 | ``` 66 | $ heatwave /path/to/my/repo 'James Stoup' 67 | ``` 68 | 69 | ![One User](https://github.com/james-stoup/heatwave/blob/master/resources/one-user.png) 70 | 71 | 72 | ### View Number of Commits 73 | View number of commits a user made, instead of color: 74 | 75 | ``` 76 | $ heatwave --status-type number /path/to/my/repo 'James Stoup' 77 | ``` 78 | 79 | ![One User By Numbers](https://github.com/james-stoup/heatwave/blob/master/resources/one-user-numbers.png) 80 | 81 | 82 | ### Other Options 83 | 84 | #### View Contributors 85 | List everyone who committed to this repo: 86 | 87 | ``` 88 | $ heatwave /path/to/my/repo -l 89 | ``` 90 | 91 | 92 | #### Verbose Mode 93 | View detailed stats on a particular committer: 94 | 95 | ``` 96 | $ heatwave -v /path/to/my/repo 'James Stoup' 97 | ``` 98 | 99 | 100 | #### Get Everything on Everyone 101 | View detailed stats on everyone going back 10 years 102 | 103 | ``` 104 | $ heatwave /path/to/my/repo -v -a -y 10 105 | ``` 106 | 107 | -------------------------------------------------------------------------------- /src/main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """ 4 | 5 | A Git Terminal Commit Viewer 6 | 7 | :author James Stoup 8 | 9 | Date: 14 APR 2019 10 | 11 | """ 12 | 13 | from operator import itemgetter 14 | import csv 15 | import operator 16 | import optparse 17 | import os 18 | import subprocess 19 | import sys 20 | import time 21 | from collections import defaultdict 22 | from datetime import date 23 | from datetime import datetime 24 | from datetime import timedelta 25 | 26 | import click 27 | import git 28 | import monthdelta 29 | from git import Repo 30 | 31 | VERSION = "1.2.1" 32 | 33 | # shamelessly copied from thispointer.com by Varun 34 | def mergeDict(dict1, dict2): 35 | """ Merge dictionaries and add values of common keys""" 36 | dict3 = {**dict1, **dict2} 37 | for key, value in dict3.items(): 38 | if key in dict1 and key in dict2: 39 | dict3[key] = value + dict1[key] 40 | 41 | return dict3 42 | 43 | 44 | def init_git(git_repo_path): 45 | """ Test to see if we can even connect to the repo given 46 | 47 | :param git_repo_path: 48 | 49 | """ 50 | repo = Repo(git_repo_path) 51 | if repo.bare: 52 | print("Error - unable to access the git repo") 53 | sys.exit() 54 | 55 | 56 | def print_git_users(git_repo_path, sorted_by_name=False): 57 | """ Print out a list of all users that have committed to the repo 58 | 59 | :param git_repo_path: 60 | 61 | """ 62 | print("Git Committers:") 63 | g = git.Git(git_repo_path) 64 | lines = g.shortlog("-s").splitlines() 65 | users = {} 66 | 67 | for line in lines: 68 | clean_line = line.strip() 69 | commits = (" ".join(line.split()).split(" ", 1))[0] 70 | author = (" ".join(line.split()).split(" ", 1))[1] 71 | users[author.upper()] = (int(commits), author) 72 | 73 | # sort by commit count 74 | sorted_users = sorted(users.items(), key=itemgetter(1), reverse=True) 75 | 76 | if sorted_by_name: 77 | # sort by user name irrespective of case 78 | sorted_users = sorted(users.items(), key=itemgetter(0)) 79 | 80 | # print sorted users 81 | for val in sorted_users: 82 | print(" {:>5} - {}".format(val[1][0], val[1][1])) 83 | 84 | print("") 85 | 86 | 87 | def print_additional_stats(user_history, git_repo, user_name): 88 | """ Throw out some additional stats on the data generated 89 | 90 | :param user_history: 91 | :param git_repo: 92 | :param user_name: 93 | 94 | """ 95 | if not user_name: 96 | user_name = "All" 97 | 98 | total_commit_days = len(user_history) 99 | total_commits = 0 100 | 101 | for key, value in user_history.items(): 102 | total_commits += value 103 | 104 | print("Git Author : {}".format(user_name)) 105 | print("Total Days : {}".format(total_commit_days)) 106 | print("Total Commits : {}".format(total_commits)) 107 | print("") 108 | 109 | 110 | def gen_slots(offset): 111 | """ Generate the slots that the slotter function will use""" 112 | 113 | # the slots list will get used by the legend at the end 114 | slots = [offset * i for i in range(1, 6)] 115 | return slots 116 | 117 | 118 | def slotter(offset, input_value): 119 | """ Creates buckets based on an offset and returns which index the input goes in """ 120 | slots = gen_slots(offset) 121 | 122 | # walk through the slots until we find the index that it goes in 123 | for index, value in enumerate(slots): 124 | if input_value <= value: 125 | return index + 1 126 | 127 | return len(slots) 128 | 129 | 130 | def generate_status_values(): 131 | """ Return the color and symbol values that will fill in the days """ 132 | 133 | space = " " 134 | end = u"\u001b[0m" 135 | 136 | # normal colors 137 | g1 = u"\u001b[48;5;118m" # bright green (less commits) 138 | g2 = u"\u001b[48;5;40m" 139 | g3 = u"\u001b[48;5;34m" 140 | g4 = u"\u001b[48;5;29m" 141 | g5 = u"\u001b[48;5;22m" # dark green (more commits) 142 | 143 | # colors for those with dark terminal schemes 144 | r1 = u"\u001b[48;5;52m" # dark red (less commits) 145 | r2 = u"\u001b[48;5;88m" 146 | r3 = u"\u001b[48;5;124m" 147 | r4 = u"\u001b[48;5;160m" 148 | r5 = u"\u001b[48;5;196m" # bright red (more commits) 149 | 150 | status_values = dict( 151 | greens={ 152 | 1: g1 + space + end, 153 | 2: g2 + space + end, 154 | 3: g3 + space + end, 155 | 4: g4 + space + end, 156 | 5: g5 + space + end, 157 | }, 158 | reds={ 159 | 1: r1 + space + end, 160 | 2: r2 + space + end, 161 | 3: r3 + space + end, 162 | 4: r4 + space + end, 163 | 5: r5 + space + end, 164 | }, 165 | symbol={1: "..", 2: "--", 3: "~~", 4: "**", 5: "##"}, 166 | ) 167 | 168 | return status_values 169 | 170 | 171 | def print_graph_key(status_type, dark_mode, shade_offset): 172 | """ Print out a key so the colors make sense 173 | 174 | :param status_type: 175 | :param dark_mode: 176 | 177 | """ 178 | 179 | # number's don't need a key, only symbols and colors 180 | if status_type != "number": 181 | 182 | print(" == COMMITS ==") 183 | 184 | status_values = generate_status_values() 185 | status_color = "symbol" 186 | 187 | # put in a check to handle darker terminals 188 | if status_type == "color": 189 | status_color = "greens" 190 | if dark_mode == True: 191 | status_color = "reds" 192 | 193 | # I liked the colors to be horizontal rather than vertical, 194 | # but now that you can specify the offset, if the offset is 195 | # larger than 4 then it starts to not line up anymore and so 196 | # to permanently combat that I just did it this way. Sigh. 197 | slots = gen_slots(shade_offset) 198 | print(" 0") 199 | 200 | for key, value in enumerate(slots): 201 | color_to_print = status_values[status_color][key + 1] 202 | print(" {}".format(color_to_print), end="") 203 | print("{}".format(color_to_print), end="") 204 | 205 | if key == len(slots) - 1: 206 | print(" {}+".format(value)) 207 | else: 208 | print(" {} ".format(value)) 209 | 210 | print(" ============") 211 | print("") 212 | 213 | 214 | def print_status(shade, status_type, verbose, dark_mode, shade_offset): 215 | """ Function to print a space of different shades of green (lightest to darkest) 216 | 217 | :param shade: 218 | :param status_type: 219 | :param verbose: 220 | :param dark_mode: 221 | 222 | """ 223 | space = " " 224 | status = generate_status_values() 225 | 226 | # either print the number of commits, or look in the dict 227 | if status_type == "number": 228 | if shade < 10: 229 | shade = " {}".format(shade) 230 | 231 | if verbose: 232 | print(u"\u001b[48;5;253m" + str(shade) + u"\u001b[0m ", end="") 233 | else: 234 | print(u"\u001b[48;5;253m" + str(shade) + u"\u001b[0m", end="") 235 | else: 236 | status_color = "" 237 | # put in a check to handle darker terminals 238 | if status_type == "color": 239 | status_color = "greens" 240 | if dark_mode is True: 241 | status_color = "reds" 242 | else: 243 | status_color = "symbol" 244 | 245 | new_shade = slotter(shade_offset, shade) 246 | 247 | if verbose: 248 | print("{} ".format(status[status_color].get(new_shade, space)), end="") 249 | else: 250 | print("{}".format(status[status_color].get(new_shade, space)), end="") 251 | 252 | 253 | def daterange(start_date, end_date): 254 | """ Return a series of dates from start to end 255 | 256 | :param start_date: 257 | :param end_date: 258 | 259 | """ 260 | for n in range(int((end_date - start_date).days)): 261 | yield start_date + timedelta(n) 262 | 263 | 264 | def find_commits(user_name, git_repo_path, end_date, start_date, all_users): 265 | """ Find the number of commits for a user on each day of the preceeding year 266 | 267 | :param user_name: 268 | :param git_repo_path: 269 | :param end_date: 270 | :param start_date: 271 | :param all_users: 272 | 273 | """ 274 | since_str = start_date.strftime("%d %b %Y") 275 | before_str = end_date.strftime("%d %b %Y") 276 | 277 | g = git.Git(git_repo_path) 278 | lines = g.log( 279 | "--date=short", 280 | '--pretty=format:"%ad %an"', 281 | '--since="{}"'.format(since_str), 282 | '--before="{}"'.format(before_str), 283 | ).splitlines() 284 | 285 | cleaned_lines = [] 286 | 287 | for line in lines: 288 | cleaned_lines.append(line.strip().replace('"', "")) 289 | 290 | user_data = defaultdict(list) 291 | 292 | # get the commits per day for the user in question 293 | for cl in cleaned_lines: 294 | commit_date = cl.split(" ", 1)[0] 295 | commit_user = cl.split(" ", 1)[1] 296 | if all_users is True: 297 | user_data[commit_date].append(commit_user) 298 | else: 299 | if user_name.lower() in commit_user.lower(): 300 | user_data[commit_date].append(commit_user) 301 | 302 | user_history = {} 303 | 304 | # now save number of commits per day 305 | for k, v in user_data.items(): 306 | user_history[k] = len(v) 307 | 308 | first_day = datetime.now() 309 | last_day = first_day - timedelta(days=365) 310 | 311 | return user_history 312 | 313 | 314 | def print_border(size, msg=""): 315 | """ Print a simple border 316 | 317 | :param size: 318 | :param msg: 319 | 320 | """ 321 | for i in range(0, size): 322 | print("=", end="") 323 | print(msg, end="") 324 | print("") 325 | 326 | 327 | def print_months_header(verbose): 328 | """ Print the header to show the months 329 | 330 | :param verbose: 331 | 332 | """ 333 | prev_month = datetime.now() 334 | month_order = [] 335 | month_header_str = " " 336 | 337 | # get the months, starting from now and working back (so we know what order to print them in) 338 | for i in range(1, 13): 339 | month_order.append(prev_month.strftime("%b")) 340 | prev_month = prev_month + monthdelta.monthdelta(-1) 341 | 342 | month_order.reverse() 343 | 344 | for key in month_order: 345 | if verbose: 346 | month_header_str += " {} ".format(key) 347 | else: 348 | month_header_str += " {} ".format(key) 349 | 350 | print(month_header_str, end="") 351 | print("") 352 | 353 | return len(month_header_str) 354 | 355 | 356 | def print_heat_map( 357 | user_history, first_day, last_day, status_type, verbose, dark_mode, shade_offset 358 | ): 359 | """ Display the heat map to the terminal using colors or symbols 360 | 361 | :param user_history: 362 | :param first_day: 363 | :param last_day: 364 | :param status_type: 365 | :param verbose: 366 | :param dark_mode: 367 | 368 | """ 369 | # make sure we always start on a Sunday 370 | year_of_commits = daterange(last_day, first_day + timedelta(days=1)) 371 | for date in year_of_commits: 372 | if date.strftime("%a") == "Sun": 373 | last_day = date 374 | break 375 | year_of_commits = daterange(last_day, first_day + timedelta(days=1)) 376 | 377 | # sort the dates into weeks 378 | week_days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"] 379 | days = defaultdict(list) 380 | 381 | for x in year_of_commits: 382 | cur_day = x.strftime("%Y-%m-%d") # format of the git commits 383 | week_day = x.strftime("%a") # format to tell the day of the week 384 | days[week_day].append(cur_day) 385 | 386 | weeks = [days[day] for day in week_days] 387 | 388 | # Now print everything 389 | labels = [" ", "Mon", " ", "Wed", " ", "Fri", " "] 390 | print_label = 0 391 | 392 | for days in weeks: 393 | # print the mon/wed/fri labels 394 | print("{} ".format(labels[print_label]), end="") 395 | 396 | # print each commit day in the chosen format 397 | for day in days: 398 | if day in user_history: 399 | print_status( 400 | user_history[day], status_type, verbose, dark_mode, shade_offset 401 | ) 402 | else: 403 | # verbose mode will print the day of the month 404 | if verbose: 405 | print("{} ".format(day.split("-")[2]), end="") 406 | else: 407 | # otherwise just print an empty space (might change later) 408 | print(" ", end="") 409 | 410 | print_label += 1 411 | print(" ") 412 | 413 | 414 | @click.command() 415 | @click.version_option(version=VERSION) 416 | @click.argument( 417 | "git-repo-path", type=click.Path(exists=True), default=".", required=True 418 | ) 419 | @click.argument("user-names", nargs=-1, required=False) 420 | @click.option( 421 | "-l", 422 | "--list-committers", 423 | is_flag=True, 424 | help="Lists all the committers for a git repo, sorted by commits", 425 | ) 426 | @click.option( 427 | "-L", 428 | "--list-committers-by-name", 429 | is_flag=True, 430 | help="Lists all the committers for a git repo, sorted by user name", 431 | ) 432 | @click.option("-y", "--years", default=1, help="Print more than one year") 433 | @click.option( 434 | "-a", 435 | "--all-users", 436 | is_flag=True, 437 | help="Print heat map for all users, not just a single user", 438 | ) 439 | @click.option( 440 | "--status-type", 441 | type=click.Choice(["color", "symbol", "number"]), 442 | default="color", 443 | help="Choose how to visualize the data", 444 | ) 445 | @click.option( 446 | "-o", 447 | "--shade-offset", 448 | default=1, 449 | help="Manually set the offset for determining the colors", 450 | ) 451 | @click.option("-v", "--verbose", is_flag=True, help="Prints additional information") 452 | @click.option( 453 | "-d", 454 | "--dark-mode", 455 | is_flag=True, 456 | default=False, 457 | help="Prints in red for darker color schemes", 458 | ) 459 | def cli( 460 | user_names, 461 | git_repo_path, 462 | list_committers, 463 | list_committers_by_name, 464 | years, 465 | all_users, 466 | status_type, 467 | shade_offset, 468 | verbose, 469 | dark_mode, 470 | ): 471 | """ 472 | 473 | Now you can view a beautiful representation of your git progress 474 | right here on the command line. No longer will you have to log 475 | into github to compulsively check to see how many commits you've 476 | made this year, now you can feel inadequate without ever having 477 | to leave the command line! 478 | 479 | ######### Example 1 ######### 480 | 481 | Print standard output 482 | 483 | ./heatwave.py /path/to/git/repo "James Stoup" 484 | 485 | 486 | ######### Example 2 ######### 487 | 488 | Print number of commits each day and show additional stats 489 | 490 | ./heatwave.py /path/to/git/repo stoup --status-type number -v 491 | 492 | 493 | ######### Example 3 ######### 494 | 495 | Print several users combined output 496 | 497 | ./heatwave.py /path/to/git/repo james, bob, "LORD CODER III", jack 498 | 499 | 500 | ######### Example 4 ######### 501 | 502 | Change the default offset to a step of 5 503 | 504 | ./heatwave.py /path/to/git/repo captain_derp -o 5 505 | 506 | """ 507 | 508 | # Error checking 509 | dot_git_dir = os.path.join(git_repo_path, ".git") 510 | if os.path.isdir(dot_git_dir) is False: 511 | print("Invalid Repository Path: {}".format(git_repo_path)) 512 | print("Please enter a path to a valid git repository!") 513 | sys.exit() 514 | 515 | if ( 516 | all_users is False 517 | and list_committers is False 518 | and list_committers_by_name is False 519 | and not user_names 520 | ): 521 | print("Must supply a USER NAME if the -l, -L, or -a flags are not used") 522 | sys.exit() 523 | 524 | # everything else depends on git working, so hop to it 525 | init_git(git_repo_path) 526 | 527 | if list_committers: 528 | print_git_users(git_repo_path) 529 | sys.exit() 530 | 531 | if list_committers_by_name: 532 | print_git_users(git_repo_path, True) 533 | sys.exit() 534 | 535 | # loop through the years 536 | end_date = datetime.now() 537 | start_date = end_date - timedelta( 538 | days=365 539 | ) # Get a year's worth of data, working back from today 540 | 541 | for i in range(years): 542 | print("") 543 | years_label = "\t{} - {}".format( 544 | start_date.strftime("%Y"), end_date.strftime("%Y") 545 | ) 546 | 547 | # if no users specified, just print everything 548 | if all_users: 549 | user_names = ["All"] 550 | 551 | # this handles multiple users, a new and handy feature! 552 | merged_history = {} 553 | 554 | for user in user_names: 555 | # find each user's history 556 | user_history = find_commits( 557 | user, git_repo_path, end_date, start_date, all_users 558 | ) 559 | 560 | if verbose: 561 | print_additional_stats(user_history, git_repo_path, user) 562 | 563 | merged_history = mergeDict(merged_history, user_history) 564 | 565 | # Print everything out 566 | header_len = print_months_header(verbose) 567 | print_border(header_len, years_label) 568 | print_heat_map( 569 | merged_history, 570 | end_date, 571 | start_date, 572 | status_type, 573 | verbose, 574 | dark_mode, 575 | shade_offset, 576 | ) 577 | print_border(header_len) 578 | print("") 579 | 580 | end_date = start_date 581 | start_date = end_date - timedelta(days=365) 582 | 583 | print_graph_key(status_type, dark_mode, shade_offset) 584 | 585 | print(" ") 586 | 587 | 588 | if __name__ == "__main__": 589 | cli() 590 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------