├── cryptomon ├── __init__.py ├── graceful_killer.py ├── stack_api_client.py ├── cryptomonitor.py ├── arbitrage_monitor.py └── html_extractor.py ├── README.md ├── setup.py └── LICENSE.txt /cryptomon/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CryptoMonitor 2 | 3 | ## Objective 4 | 5 | The application is to monitor the cryptocurrency prices, spot the arbitrage 6 | opportunity, and notify the users in Slack. -------------------------------------------------------------------------------- /cryptomon/graceful_killer.py: -------------------------------------------------------------------------------- 1 | #!/bin/python 2 | import signal 3 | 4 | class GracefulKiller: 5 | kill_now = False 6 | def __init__(self): 7 | signal.signal(signal.SIGINT, self.exit_gracefully) 8 | signal.signal(signal.SIGTERM, self.exit_gracefully) 9 | 10 | def exit_gracefully(self,signum, frame): 11 | self.kill_now = True -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | 3 | setup( 4 | name='CryptoMonitor', 5 | version='beta', 6 | author='Aurora Trading Team', 7 | author_email='auroratradingteam@gmail.com', 8 | packages=['cryptomon'], 9 | url='http://pypi.python.org/pypi/CryptoMonitor/', 10 | license='LICENSE.txt', 11 | description='Cryptocurrency price arbitrage monitor.', 12 | entry_points={ 13 | 'console_scripts': ['cryptomon=cryptomon.cryptomonitor:main'] 14 | }, 15 | install_requires=[ 16 | 'beautifulsoup4', 17 | 'slacker' 18 | ] 19 | ) -------------------------------------------------------------------------------- /cryptomon/stack_api_client.py: -------------------------------------------------------------------------------- 1 | #!/bin/python 2 | from slacker import Slacker 3 | 4 | class SlackApiClient(Slacker): 5 | """ 6 | Slack API client 7 | """ 8 | USERNAME = 'cryptomonitor' 9 | 10 | def __init__(self, key, channel): 11 | """ 12 | Constructor 13 | """ 14 | Slacker.__init__(self, key) 15 | self.channel = channel 16 | 17 | def post_message(self, message): 18 | """ 19 | Post message 20 | """ 21 | self.chat.post_message(self.channel, message, username=SlackApiClient.USERNAME) 22 | 23 | 24 | if __name__ == '__main__': 25 | key = '' 26 | slack = Slacker(key) 27 | slack.chat.post_message('#arbsignal', 'Hello world!', username='cryptomonitor') -------------------------------------------------------------------------------- /cryptomon/cryptomonitor.py: -------------------------------------------------------------------------------- 1 | #!/bin/python 2 | from cryptomon.html_extractor import HtmlExtractor 3 | from cryptomon.stack_api_client import SlackApiClient 4 | from cryptomon.graceful_killer import GracefulKiller 5 | from cryptomon.arbitrage_monitor import ArbitrageMonitor 6 | import sys 7 | import argparse 8 | import time 9 | import requests 10 | 11 | def main(): 12 | parser = argparse.ArgumentParser(description='Cryptocurrency monitor.') 13 | parser.add_argument('-pair', 14 | action='append', 15 | dest='pair', 16 | help='Symbol with an arbitrage level.', 17 | nargs='+', 18 | metavar=('symbol', 'value')) 19 | parser.add_argument('-nerror', 20 | action='store', 21 | dest='nerror', 22 | help='Exception tolerance level.', 23 | default=10) 24 | parser.add_argument('-sleep', 25 | action='store', 26 | dest='sleep', 27 | help='Sleep time between each request.', 28 | default=30) 29 | parser.add_argument('-key', 30 | action='store', 31 | dest='key', 32 | help='Slack API key.') 33 | parser.add_argument('-channel', 34 | action='store', 35 | dest='channel', 36 | help='Slack channel.', 37 | default='#arbsignal') 38 | 39 | args = parser.parse_args() 40 | 41 | if args.pair is None or len(args.pair) == 0: 42 | print("[ERROR] No symbol pair.") 43 | parser.print_help() 44 | sys.exit(1) 45 | 46 | ##################################################################################### 47 | # Initialize variables 48 | for pair in args.pair: 49 | if len(pair) != 2: 50 | print("[ERROR] First value is the symbol and the second value is the level.") 51 | parser.print_help() 52 | sys.exit(1) 53 | else: 54 | pair[1] = float(pair[1]) 55 | 56 | if args.key is None: 57 | print("[ERROR] Slack API key is mandatory.") 58 | parser.print_help() 59 | sys.exit(1) 60 | 61 | if args.channel is None or len(args.channel) == 0: 62 | print("[ERROR] Slack channel cannot be empty.") 63 | parser.print_help() 64 | sys.exit(1) 65 | elif args.channel[0] != '#': 66 | print("[ERROR] Slack channel must begin with #.") 67 | parser.print_help() 68 | sys.exit(1) 69 | 70 | if not isinstance(args.nerror, int): 71 | args.nerror = int(args.nerror) 72 | 73 | if not isinstance(args.sleep, int): 74 | args.sleep = int(args.sleep) 75 | 76 | 77 | ##################################################################################### 78 | 79 | # Variables 80 | slack = SlackApiClient(args.key, args.channel) 81 | extractor = HtmlExtractor() 82 | killer = GracefulKiller() 83 | monitor = ArbitrageMonitor(pairs=args.pair, 84 | killer=killer, 85 | slack=slack, 86 | extractor=extractor, 87 | sleep_sec=args.sleep, 88 | max_error_count=args.nerror) 89 | monitor.run() 90 | 91 | if __name__ == '__main__': 92 | main() 93 | -------------------------------------------------------------------------------- /cryptomon/arbitrage_monitor.py: -------------------------------------------------------------------------------- 1 | #!/bin/python 2 | from datetime import datetime 3 | import time 4 | 5 | class ArbitrageMonitor(object): 6 | """ 7 | Arbitrage monitor 8 | """ 9 | def __init__(self, 10 | pairs, 11 | killer, 12 | extractor, 13 | slack, 14 | sleep_sec, 15 | max_error_count): 16 | """ 17 | Constructor 18 | """ 19 | self.arb_pairs_store = {} 20 | self.error_count = 0 21 | self.pairs = pairs 22 | self.killer = killer 23 | self.extractor = extractor 24 | self.slack = slack 25 | self.sleep_sec = sleep_sec 26 | self.max_error_count = max_error_count 27 | 28 | def check_if_signal(self, arb, pair): 29 | """ 30 | Check whether to singal the arbitrage pair 31 | """ 32 | if arb is None: 33 | return False 34 | 35 | symbol = pair[0] 36 | 37 | if symbol not in self.arb_pairs_store.keys(): 38 | self.arb_pairs_store[symbol] = arb 39 | return True 40 | else: 41 | prev_arb = self.arb_pairs_store[symbol] 42 | if (prev_arb[0].exchange == arb[0].exchange and 43 | prev_arb[0].pair == arb[0].pair and 44 | prev_arb[1].exchange == arb[1].exchange and 45 | prev_arb[1].pair == arb[1].pair): 46 | # Same as the previous arbitrage signal 47 | return False 48 | else: 49 | # Different from the previous arbitrage signal 50 | self.arb_pairs_store[symbol] = arb 51 | return True 52 | 53 | def post(self, message): 54 | """ 55 | Post message 56 | """ 57 | message = (("[%s]\n" % datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S")) + 58 | message + "\n") 59 | print(message) 60 | self.slack.post_message(message) 61 | 62 | def run(self): 63 | """ 64 | Run 65 | """ 66 | message = "CryptoMonitor is started...\n" 67 | for pair in self.pairs: 68 | message += ("\tSymbol: %s, Level: %.2f%%\n" % (pair[0], pair[1] * 100)) 69 | self.post(message) 70 | 71 | try: 72 | while not self.killer.kill_now: 73 | for pair in self.pairs: 74 | # Quick exit if signal is received. 75 | if self.killer.kill_now: 76 | break 77 | 78 | symbol = pair[0] 79 | level = pair[1] 80 | 81 | # Try to get the arbitage pair. 82 | # If the exception tolerance count is met, the program will exit. 83 | try: 84 | arb = self.extractor.get_arbitrage_pair(symbol, level) 85 | except Exception as e: 86 | self.error_count += 1 87 | if self.error_count >= self.max_error_count: 88 | print("[ERROR] Number of exceptions exceeds the tolerance level (%d).\n%s" % 89 | (self.max_error_count, e)) 90 | raise e 91 | else: 92 | continue 93 | 94 | if self.check_if_signal(arb, pair): 95 | if arb[0].price > arb[1].price: 96 | ratio = arb[0].price/arb[1].price - 1 97 | else: 98 | ratio = arb[1].price/arb[0].price - 1 99 | ratio *= 100 100 | 101 | message = ("Arbitrage pair on %s [%.2f%%]:\n%s\n%s" % 102 | (symbol, 103 | ratio, 104 | arb[0], 105 | arb[1])) 106 | self.post(message) 107 | 108 | time.sleep(self.sleep_sec) 109 | 110 | except Exception as e: 111 | self.post("CryptoMonitor is closed.") 112 | raise e 113 | finally: 114 | self.post("CryptoMonitor is closed.") -------------------------------------------------------------------------------- /cryptomon/html_extractor.py: -------------------------------------------------------------------------------- 1 | #!/bin/python 2 | from bs4 import BeautifulSoup 3 | import requests 4 | import re 5 | 6 | class CurrencyPair(object): 7 | """ 8 | Information of exchange, pair, price, market share. 9 | """ 10 | def __init__(self, exchange, pair, price, market_share): 11 | """ 12 | Constructor 13 | """ 14 | self.exchange = exchange 15 | self.pair = pair 16 | self.price = price 17 | self.market_share = market_share 18 | 19 | def __str__(self): 20 | return ("Exchange: %s, Pair: %s, Price: %.8f, Market share: %.2f%%" % 21 | (self.exchange, self.pair, self.price, self.market_share)) 22 | 23 | class HtmlExtractor(object): 24 | """ 25 | Extract the cryptocurrency price information from the website coinmarketcap. 26 | By default, only the first 10 records (more than 10% of market cap) is recorded. 27 | """ 28 | URL = "https://coinmarketcap.com/currencies/%s/#markets" 29 | MAX_COMPARE_PAIRS = 10 30 | NUMBER = 10 31 | ID_INDEX = 0 32 | EXCHANGE_INDEX = 1 33 | PAIR_INDEX = 2 34 | VOLUME_INDEX = 3 35 | PRICE_INDEX = 4 36 | MARKET_SHARE_INDEX = 5 37 | LATEST_UPDATE_INDEX = 6 38 | 39 | def __init__(self): 40 | """ 41 | Constructor 42 | """ 43 | pass 44 | 45 | def get_data(self, symbol): 46 | """ 47 | Get data from the symbol and parse it. 48 | :param symbol: Symbol 49 | :returns Array of market volume 50 | """ 51 | ret = [] 52 | response = requests.get(HtmlExtractor.URL % symbol) 53 | if response.status_code == 200: 54 | # Successful 55 | soup = BeautifulSoup(response.text, 'html.parser') 56 | tables = soup.find_all('table') 57 | market_table = None 58 | for table in tables: 59 | if table.has_attr('id'): 60 | market_table = table 61 | assert market_table is not None, "Cannot find table markets-table" 62 | table_body = market_table.find_all('tbody') 63 | assert len(table_body) == 1, \ 64 | "Number of table body (%d) should be equal to 1." % len(table_body) 65 | records = table_body[0].find_all('tr') 66 | 67 | # Parse each record 68 | for record in records: 69 | entries = record.find_all('td') 70 | exchange = entries[HtmlExtractor.EXCHANGE_INDEX].text 71 | pair = entries[HtmlExtractor.PAIR_INDEX].text 72 | price = re.search("(\d+\.*\d*)", 73 | entries[HtmlExtractor.PRICE_INDEX].text).group(0) 74 | price = float(price) 75 | market_share = re.search("(\d+\.*\d*)", 76 | entries[HtmlExtractor.MARKET_SHARE_INDEX].text).group(0) 77 | market_share = float(market_share) 78 | update = entries[HtmlExtractor.LATEST_UPDATE_INDEX].text 79 | if update == "Recently": 80 | ret.append(CurrencyPair(exchange, pair, price, market_share)) 81 | else: 82 | # Failed 83 | raise requests.exceptions.HTTPError("Http request error: %d" % response.status_code) 84 | 85 | return ret 86 | 87 | def get_arbitrage_pair(self, symbol, price_diff): 88 | """ 89 | Get arbitrage pair 90 | :param symbol Symbol name 91 | :param price_diff Price difference 92 | :return Tuple of arbitrage pair. None if not found. 93 | """ 94 | pairs = self.get_data(symbol) 95 | num_of_pairs = min(len(pairs), HtmlExtractor.MAX_COMPARE_PAIRS) 96 | arb_pairs = [] 97 | 98 | # Find all the arbitrage pairs 99 | for i in range(0, num_of_pairs): 100 | for j in range(i+1, num_of_pairs): 101 | if (pairs[i].price > 0 and pairs[j].price and 102 | (pairs[i].price / pairs[j].price > 1 + price_diff or 103 | pairs[j].price / pairs[i].price > 1 + price_diff)): 104 | arb_pairs.append((pairs[i], pairs[j])) 105 | 106 | if len(arb_pairs) > 0: 107 | arb_pairs = sorted(arb_pairs, 108 | key=(lambda x: x[0].market_share + x[1].market_share), 109 | reverse=True) 110 | return arb_pairs[0] 111 | else: 112 | return None 113 | 114 | if __name__ == '__main__': 115 | extractor = HtmlExtractor() 116 | currency = "ripple" 117 | response = extractor.get_arbitrage_pair(currency, 0.05) 118 | if response is not None: 119 | print("Arbitrage pair on %s:\n%s\n%s" % (currency, response[0], response[1])) 120 | else: 121 | print("No arbitrage pair on %s." % currency) -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Home / Licenses 2 | GNU General Public License v3.0 3 | 4 | GNU GPLv3 5 | 6 | Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. 7 | 8 | Permissions Conditions Limitations 9 | Commercial use 10 | Distribution 11 | Modification 12 | Patent use 13 | Private use 14 | Disclose source 15 | License and copyright notice 16 | Same license 17 | State changes 18 | Liability 19 | Warranty 20 | GNU GENERAL PUBLIC LICENSE 21 | Version 3, 29 June 2007 22 | 23 | Copyright (C) 2007 Free Software Foundation, Inc. 24 | Everyone is permitted to copy and distribute verbatim copies 25 | of this license document, but changing it is not allowed. 26 | 27 | Preamble 28 | 29 | The GNU General Public License is a free, copyleft license for 30 | software and other kinds of works. 31 | 32 | The licenses for most software and other practical works are designed 33 | to take away your freedom to share and change the works. By contrast, 34 | the GNU General Public License is intended to guarantee your freedom to 35 | share and change all versions of a program--to make sure it remains free 36 | software for all its users. We, the Free Software Foundation, use the 37 | GNU General Public License for most of our software; it applies also to 38 | any other work released this way by its authors. You can apply it to 39 | your programs, too. 40 | 41 | When we speak of free software, we are referring to freedom, not 42 | price. Our General Public Licenses are designed to make sure that you 43 | have the freedom to distribute copies of free software (and charge for 44 | them if you wish), that you receive source code or can get it if you 45 | want it, that you can change the software or use pieces of it in new 46 | free programs, and that you know you can do these things. 47 | 48 | To protect your rights, we need to prevent others from denying you 49 | these rights or asking you to surrender the rights. Therefore, you have 50 | certain responsibilities if you distribute copies of the software, or if 51 | you modify it: responsibilities to respect the freedom of others. 52 | 53 | For example, if you distribute copies of such a program, whether 54 | gratis or for a fee, you must pass on to the recipients the same 55 | freedoms that you received. You must make sure that they, too, receive 56 | or can get the source code. And you must show them these terms so they 57 | know their rights. 58 | 59 | Developers that use the GNU GPL protect your rights with two steps: 60 | (1) assert copyright on the software, and (2) offer you this License 61 | giving you legal permission to copy, distribute and/or modify it. 62 | 63 | For the developers' and authors' protection, the GPL clearly explains 64 | that there is no warranty for this free software. For both users' and 65 | authors' sake, the GPL requires that modified versions be marked as 66 | changed, so that their problems will not be attributed erroneously to 67 | authors of previous versions. 68 | 69 | Some devices are designed to deny users access to install or run 70 | modified versions of the software inside them, although the manufacturer 71 | can do so. This is fundamentally incompatible with the aim of 72 | protecting users' freedom to change the software. The systematic 73 | pattern of such abuse occurs in the area of products for individuals to 74 | use, which is precisely where it is most unacceptable. Therefore, we 75 | have designed this version of the GPL to prohibit the practice for those 76 | products. If such problems arise substantially in other domains, we 77 | stand ready to extend this provision to those domains in future versions 78 | of the GPL, as needed to protect the freedom of users. 79 | 80 | Finally, every program is threatened constantly by software patents. 81 | States should not allow patents to restrict development and use of 82 | software on general-purpose computers, but in those that do, we wish to 83 | avoid the special danger that patents applied to a free program could 84 | make it effectively proprietary. To prevent this, the GPL assures that 85 | patents cannot be used to render the program non-free. 86 | 87 | The precise terms and conditions for copying, distribution and 88 | modification follow. 89 | 90 | TERMS AND CONDITIONS 91 | 92 | 0. Definitions. 93 | 94 | "This License" refers to version 3 of the GNU General Public License. 95 | 96 | "Copyright" also means copyright-like laws that apply to other kinds of 97 | works, such as semiconductor masks. 98 | 99 | "The Program" refers to any copyrightable work licensed under this 100 | License. Each licensee is addressed as "you". "Licensees" and 101 | "recipients" may be individuals or organizations. 102 | 103 | To "modify" a work means to copy from or adapt all or part of the work 104 | in a fashion requiring copyright permission, other than the making of an 105 | exact copy. The resulting work is called a "modified version" of the 106 | earlier work or a work "based on" the earlier work. 107 | 108 | A "covered work" means either the unmodified Program or a work based 109 | on the Program. 110 | 111 | To "propagate" a work means to do anything with it that, without 112 | permission, would make you directly or secondarily liable for 113 | infringement under applicable copyright law, except executing it on a 114 | computer or modifying a private copy. Propagation includes copying, 115 | distribution (with or without modification), making available to the 116 | public, and in some countries other activities as well. 117 | 118 | To "convey" a work means any kind of propagation that enables other 119 | parties to make or receive copies. Mere interaction with a user through 120 | a computer network, with no transfer of a copy, is not conveying. 121 | 122 | An interactive user interface displays "Appropriate Legal Notices" 123 | to the extent that it includes a convenient and prominently visible 124 | feature that (1) displays an appropriate copyright notice, and (2) 125 | tells the user that there is no warranty for the work (except to the 126 | extent that warranties are provided), that licensees may convey the 127 | work under this License, and how to view a copy of this License. If 128 | the interface presents a list of user commands or options, such as a 129 | menu, a prominent item in the list meets this criterion. 130 | 131 | 1. Source Code. 132 | 133 | The "source code" for a work means the preferred form of the work 134 | for making modifications to it. "Object code" means any non-source 135 | form of a work. 136 | 137 | A "Standard Interface" means an interface that either is an official 138 | standard defined by a recognized standards body, or, in the case of 139 | interfaces specified for a particular programming language, one that 140 | is widely used among developers working in that language. 141 | 142 | The "System Libraries" of an executable work include anything, other 143 | than the work as a whole, that (a) is included in the normal form of 144 | packaging a Major Component, but which is not part of that Major 145 | Component, and (b) serves only to enable use of the work with that 146 | Major Component, or to implement a Standard Interface for which an 147 | implementation is available to the public in source code form. A 148 | "Major Component", in this context, means a major essential component 149 | (kernel, window system, and so on) of the specific operating system 150 | (if any) on which the executable work runs, or a compiler used to 151 | produce the work, or an object code interpreter used to run it. 152 | 153 | The "Corresponding Source" for a work in object code form means all 154 | the source code needed to generate, install, and (for an executable 155 | work) run the object code and to modify the work, including scripts to 156 | control those activities. However, it does not include the work's 157 | System Libraries, or general-purpose tools or generally available free 158 | programs which are used unmodified in performing those activities but 159 | which are not part of the work. For example, Corresponding Source 160 | includes interface definition files associated with source files for 161 | the work, and the source code for shared libraries and dynamically 162 | linked subprograms that the work is specifically designed to require, 163 | such as by intimate data communication or control flow between those 164 | subprograms and other parts of the work. 165 | 166 | The Corresponding Source need not include anything that users 167 | can regenerate automatically from other parts of the Corresponding 168 | Source. 169 | 170 | The Corresponding Source for a work in source code form is that 171 | same work. 172 | 173 | 2. Basic Permissions. 174 | 175 | All rights granted under this License are granted for the term of 176 | copyright on the Program, and are irrevocable provided the stated 177 | conditions are met. This License explicitly affirms your unlimited 178 | permission to run the unmodified Program. The output from running a 179 | covered work is covered by this License only if the output, given its 180 | content, constitutes a covered work. This License acknowledges your 181 | rights of fair use or other equivalent, as provided by copyright law. 182 | 183 | You may make, run and propagate covered works that you do not 184 | convey, without conditions so long as your license otherwise remains 185 | in force. You may convey covered works to others for the sole purpose 186 | of having them make modifications exclusively for you, or provide you 187 | with facilities for running those works, provided that you comply with 188 | the terms of this License in conveying all material for which you do 189 | not control copyright. Those thus making or running the covered works 190 | for you must do so exclusively on your behalf, under your direction 191 | and control, on terms that prohibit them from making any copies of 192 | your copyrighted material outside their relationship with you. 193 | 194 | Conveying under any other circumstances is permitted solely under 195 | the conditions stated below. Sublicensing is not allowed; section 10 196 | makes it unnecessary. 197 | 198 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 199 | 200 | No covered work shall be deemed part of an effective technological 201 | measure under any applicable law fulfilling obligations under article 202 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 203 | similar laws prohibiting or restricting circumvention of such 204 | measures. 205 | 206 | When you convey a covered work, you waive any legal power to forbid 207 | circumvention of technological measures to the extent such circumvention 208 | is effected by exercising rights under this License with respect to 209 | the covered work, and you disclaim any intention to limit operation or 210 | modification of the work as a means of enforcing, against the work's 211 | users, your or third parties' legal rights to forbid circumvention of 212 | technological measures. 213 | 214 | 4. Conveying Verbatim Copies. 215 | 216 | You may convey verbatim copies of the Program's source code as you 217 | receive it, in any medium, provided that you conspicuously and 218 | appropriately publish on each copy an appropriate copyright notice; 219 | keep intact all notices stating that this License and any 220 | non-permissive terms added in accord with section 7 apply to the code; 221 | keep intact all notices of the absence of any warranty; and give all 222 | recipients a copy of this License along with the Program. 223 | 224 | You may charge any price or no price for each copy that you convey, 225 | and you may offer support or warranty protection for a fee. 226 | 227 | 5. Conveying Modified Source Versions. 228 | 229 | You may convey a work based on the Program, or the modifications to 230 | produce it from the Program, in the form of source code under the 231 | terms of section 4, provided that you also meet all of these conditions: 232 | 233 | a) The work must carry prominent notices stating that you modified 234 | it, and giving a relevant date. 235 | 236 | b) The work must carry prominent notices stating that it is 237 | released under this License and any conditions added under section 238 | 7. This requirement modifies the requirement in section 4 to 239 | "keep intact all notices". 240 | 241 | c) You must license the entire work, as a whole, under this 242 | License to anyone who comes into possession of a copy. This 243 | License will therefore apply, along with any applicable section 7 244 | additional terms, to the whole of the work, and all its parts, 245 | regardless of how they are packaged. This License gives no 246 | permission to license the work in any other way, but it does not 247 | invalidate such permission if you have separately received it. 248 | 249 | d) If the work has interactive user interfaces, each must display 250 | Appropriate Legal Notices; however, if the Program has interactive 251 | interfaces that do not display Appropriate Legal Notices, your 252 | work need not make them do so. 253 | 254 | A compilation of a covered work with other separate and independent 255 | works, which are not by their nature extensions of the covered work, 256 | and which are not combined with it such as to form a larger program, 257 | in or on a volume of a storage or distribution medium, is called an 258 | "aggregate" if the compilation and its resulting copyright are not 259 | used to limit the access or legal rights of the compilation's users 260 | beyond what the individual works permit. Inclusion of a covered work 261 | in an aggregate does not cause this License to apply to the other 262 | parts of the aggregate. 263 | 264 | 6. Conveying Non-Source Forms. 265 | 266 | You may convey a covered work in object code form under the terms 267 | of sections 4 and 5, provided that you also convey the 268 | machine-readable Corresponding Source under the terms of this License, 269 | in one of these ways: 270 | 271 | a) Convey the object code in, or embodied in, a physical product 272 | (including a physical distribution medium), accompanied by the 273 | Corresponding Source fixed on a durable physical medium 274 | customarily used for software interchange. 275 | 276 | b) Convey the object code in, or embodied in, a physical product 277 | (including a physical distribution medium), accompanied by a 278 | written offer, valid for at least three years and valid for as 279 | long as you offer spare parts or customer support for that product 280 | model, to give anyone who possesses the object code either (1) a 281 | copy of the Corresponding Source for all the software in the 282 | product that is covered by this License, on a durable physical 283 | medium customarily used for software interchange, for a price no 284 | more than your reasonable cost of physically performing this 285 | conveying of source, or (2) access to copy the 286 | Corresponding Source from a network server at no charge. 287 | 288 | c) Convey individual copies of the object code with a copy of the 289 | written offer to provide the Corresponding Source. This 290 | alternative is allowed only occasionally and noncommercially, and 291 | only if you received the object code with such an offer, in accord 292 | with subsection 6b. 293 | 294 | d) Convey the object code by offering access from a designated 295 | place (gratis or for a charge), and offer equivalent access to the 296 | Corresponding Source in the same way through the same place at no 297 | further charge. You need not require recipients to copy the 298 | Corresponding Source along with the object code. If the place to 299 | copy the object code is a network server, the Corresponding Source 300 | may be on a different server (operated by you or a third party) 301 | that supports equivalent copying facilities, provided you maintain 302 | clear directions next to the object code saying where to find the 303 | Corresponding Source. Regardless of what server hosts the 304 | Corresponding Source, you remain obligated to ensure that it is 305 | available for as long as needed to satisfy these requirements. 306 | 307 | e) Convey the object code using peer-to-peer transmission, provided 308 | you inform other peers where the object code and Corresponding 309 | Source of the work are being offered to the general public at no 310 | charge under subsection 6d. 311 | 312 | A separable portion of the object code, whose source code is excluded 313 | from the Corresponding Source as a System Library, need not be 314 | included in conveying the object code work. 315 | 316 | A "User Product" is either (1) a "consumer product", which means any 317 | tangible personal property which is normally used for personal, family, 318 | or household purposes, or (2) anything designed or sold for incorporation 319 | into a dwelling. In determining whether a product is a consumer product, 320 | doubtful cases shall be resolved in favor of coverage. For a particular 321 | product received by a particular user, "normally used" refers to a 322 | typical or common use of that class of product, regardless of the status 323 | of the particular user or of the way in which the particular user 324 | actually uses, or expects or is expected to use, the product. A product 325 | is a consumer product regardless of whether the product has substantial 326 | commercial, industrial or non-consumer uses, unless such uses represent 327 | the only significant mode of use of the product. 328 | 329 | "Installation Information" for a User Product means any methods, 330 | procedures, authorization keys, or other information required to install 331 | and execute modified versions of a covered work in that User Product from 332 | a modified version of its Corresponding Source. The information must 333 | suffice to ensure that the continued functioning of the modified object 334 | code is in no case prevented or interfered with solely because 335 | modification has been made. 336 | 337 | If you convey an object code work under this section in, or with, or 338 | specifically for use in, a User Product, and the conveying occurs as 339 | part of a transaction in which the right of possession and use of the 340 | User Product is transferred to the recipient in perpetuity or for a 341 | fixed term (regardless of how the transaction is characterized), the 342 | Corresponding Source conveyed under this section must be accompanied 343 | by the Installation Information. But this requirement does not apply 344 | if neither you nor any third party retains the ability to install 345 | modified object code on the User Product (for example, the work has 346 | been installed in ROM). 347 | 348 | The requirement to provide Installation Information does not include a 349 | requirement to continue to provide support service, warranty, or updates 350 | for a work that has been modified or installed by the recipient, or for 351 | the User Product in which it has been modified or installed. Access to a 352 | network may be denied when the modification itself materially and 353 | adversely affects the operation of the network or violates the rules and 354 | protocols for communication across the network. 355 | 356 | Corresponding Source conveyed, and Installation Information provided, 357 | in accord with this section must be in a format that is publicly 358 | documented (and with an implementation available to the public in 359 | source code form), and must require no special password or key for 360 | unpacking, reading or copying. 361 | 362 | 7. Additional Terms. 363 | 364 | "Additional permissions" are terms that supplement the terms of this 365 | License by making exceptions from one or more of its conditions. 366 | Additional permissions that are applicable to the entire Program shall 367 | be treated as though they were included in this License, to the extent 368 | that they are valid under applicable law. If additional permissions 369 | apply only to part of the Program, that part may be used separately 370 | under those permissions, but the entire Program remains governed by 371 | this License without regard to the additional permissions. 372 | 373 | When you convey a copy of a covered work, you may at your option 374 | remove any additional permissions from that copy, or from any part of 375 | it. (Additional permissions may be written to require their own 376 | removal in certain cases when you modify the work.) You may place 377 | additional permissions on material, added by you to a covered work, 378 | for which you have or can give appropriate copyright permission. 379 | 380 | Notwithstanding any other provision of this License, for material you 381 | add to a covered work, you may (if authorized by the copyright holders of 382 | that material) supplement the terms of this License with terms: 383 | 384 | a) Disclaiming warranty or limiting liability differently from the 385 | terms of sections 15 and 16 of this License; or 386 | 387 | b) Requiring preservation of specified reasonable legal notices or 388 | author attributions in that material or in the Appropriate Legal 389 | Notices displayed by works containing it; or 390 | 391 | c) Prohibiting misrepresentation of the origin of that material, or 392 | requiring that modified versions of such material be marked in 393 | reasonable ways as different from the original version; or 394 | 395 | d) Limiting the use for publicity purposes of names of licensors or 396 | authors of the material; or 397 | 398 | e) Declining to grant rights under trademark law for use of some 399 | trade names, trademarks, or service marks; or 400 | 401 | f) Requiring indemnification of licensors and authors of that 402 | material by anyone who conveys the material (or modified versions of 403 | it) with contractual assumptions of liability to the recipient, for 404 | any liability that these contractual assumptions directly impose on 405 | those licensors and authors. 406 | 407 | All other non-permissive additional terms are considered "further 408 | restrictions" within the meaning of section 10. If the Program as you 409 | received it, or any part of it, contains a notice stating that it is 410 | governed by this License along with a term that is a further 411 | restriction, you may remove that term. If a license document contains 412 | a further restriction but permits relicensing or conveying under this 413 | License, you may add to a covered work material governed by the terms 414 | of that license document, provided that the further restriction does 415 | not survive such relicensing or conveying. 416 | 417 | If you add terms to a covered work in accord with this section, you 418 | must place, in the relevant source files, a statement of the 419 | additional terms that apply to those files, or a notice indicating 420 | where to find the applicable terms. 421 | 422 | Additional terms, permissive or non-permissive, may be stated in the 423 | form of a separately written license, or stated as exceptions; 424 | the above requirements apply either way. 425 | 426 | 8. Termination. 427 | 428 | You may not propagate or modify a covered work except as expressly 429 | provided under this License. Any attempt otherwise to propagate or 430 | modify it is void, and will automatically terminate your rights under 431 | this License (including any patent licenses granted under the third 432 | paragraph of section 11). 433 | 434 | However, if you cease all violation of this License, then your 435 | license from a particular copyright holder is reinstated (a) 436 | provisionally, unless and until the copyright holder explicitly and 437 | finally terminates your license, and (b) permanently, if the copyright 438 | holder fails to notify you of the violation by some reasonable means 439 | prior to 60 days after the cessation. 440 | 441 | Moreover, your license from a particular copyright holder is 442 | reinstated permanently if the copyright holder notifies you of the 443 | violation by some reasonable means, this is the first time you have 444 | received notice of violation of this License (for any work) from that 445 | copyright holder, and you cure the violation prior to 30 days after 446 | your receipt of the notice. 447 | 448 | Termination of your rights under this section does not terminate the 449 | licenses of parties who have received copies or rights from you under 450 | this License. If your rights have been terminated and not permanently 451 | reinstated, you do not qualify to receive new licenses for the same 452 | material under section 10. 453 | 454 | 9. Acceptance Not Required for Having Copies. 455 | 456 | You are not required to accept this License in order to receive or 457 | run a copy of the Program. Ancillary propagation of a covered work 458 | occurring solely as a consequence of using peer-to-peer transmission 459 | to receive a copy likewise does not require acceptance. However, 460 | nothing other than this License grants you permission to propagate or 461 | modify any covered work. These actions infringe copyright if you do 462 | not accept this License. Therefore, by modifying or propagating a 463 | covered work, you indicate your acceptance of this License to do so. 464 | 465 | 10. Automatic Licensing of Downstream Recipients. 466 | 467 | Each time you convey a covered work, the recipient automatically 468 | receives a license from the original licensors, to run, modify and 469 | propagate that work, subject to this License. You are not responsible 470 | for enforcing compliance by third parties with this License. 471 | 472 | An "entity transaction" is a transaction transferring control of an 473 | organization, or substantially all assets of one, or subdividing an 474 | organization, or merging organizations. If propagation of a covered 475 | work results from an entity transaction, each party to that 476 | transaction who receives a copy of the work also receives whatever 477 | licenses to the work the party's predecessor in interest had or could 478 | give under the previous paragraph, plus a right to possession of the 479 | Corresponding Source of the work from the predecessor in interest, if 480 | the predecessor has it or can get it with reasonable efforts. 481 | 482 | You may not impose any further restrictions on the exercise of the 483 | rights granted or affirmed under this License. For example, you may 484 | not impose a license fee, royalty, or other charge for exercise of 485 | rights granted under this License, and you may not initiate litigation 486 | (including a cross-claim or counterclaim in a lawsuit) alleging that 487 | any patent claim is infringed by making, using, selling, offering for 488 | sale, or importing the Program or any portion of it. 489 | 490 | 11. Patents. 491 | 492 | A "contributor" is a copyright holder who authorizes use under this 493 | License of the Program or a work on which the Program is based. The 494 | work thus licensed is called the contributor's "contributor version". 495 | 496 | A contributor's "essential patent claims" are all patent claims 497 | owned or controlled by the contributor, whether already acquired or 498 | hereafter acquired, that would be infringed by some manner, permitted 499 | by this License, of making, using, or selling its contributor version, 500 | but do not include claims that would be infringed only as a 501 | consequence of further modification of the contributor version. For 502 | purposes of this definition, "control" includes the right to grant 503 | patent sublicenses in a manner consistent with the requirements of 504 | this License. 505 | 506 | Each contributor grants you a non-exclusive, worldwide, royalty-free 507 | patent license under the contributor's essential patent claims, to 508 | make, use, sell, offer for sale, import and otherwise run, modify and 509 | propagate the contents of its contributor version. 510 | 511 | In the following three paragraphs, a "patent license" is any express 512 | agreement or commitment, however denominated, not to enforce a patent 513 | (such as an express permission to practice a patent or covenant not to 514 | sue for patent infringement). To "grant" such a patent license to a 515 | party means to make such an agreement or commitment not to enforce a 516 | patent against the party. 517 | 518 | If you convey a covered work, knowingly relying on a patent license, 519 | and the Corresponding Source of the work is not available for anyone 520 | to copy, free of charge and under the terms of this License, through a 521 | publicly available network server or other readily accessible means, 522 | then you must either (1) cause the Corresponding Source to be so 523 | available, or (2) arrange to deprive yourself of the benefit of the 524 | patent license for this particular work, or (3) arrange, in a manner 525 | consistent with the requirements of this License, to extend the patent 526 | license to downstream recipients. "Knowingly relying" means you have 527 | actual knowledge that, but for the patent license, your conveying the 528 | covered work in a country, or your recipient's use of the covered work 529 | in a country, would infringe one or more identifiable patents in that 530 | country that you have reason to believe are valid. 531 | 532 | If, pursuant to or in connection with a single transaction or 533 | arrangement, you convey, or propagate by procuring conveyance of, a 534 | covered work, and grant a patent license to some of the parties 535 | receiving the covered work authorizing them to use, propagate, modify 536 | or convey a specific copy of the covered work, then the patent license 537 | you grant is automatically extended to all recipients of the covered 538 | work and works based on it. 539 | 540 | A patent license is "discriminatory" if it does not include within 541 | the scope of its coverage, prohibits the exercise of, or is 542 | conditioned on the non-exercise of one or more of the rights that are 543 | specifically granted under this License. You may not convey a covered 544 | work if you are a party to an arrangement with a third party that is 545 | in the business of distributing software, under which you make payment 546 | to the third party based on the extent of your activity of conveying 547 | the work, and under which the third party grants, to any of the 548 | parties who would receive the covered work from you, a discriminatory 549 | patent license (a) in connection with copies of the covered work 550 | conveyed by you (or copies made from those copies), or (b) primarily 551 | for and in connection with specific products or compilations that 552 | contain the covered work, unless you entered into that arrangement, 553 | or that patent license was granted, prior to 28 March 2007. 554 | 555 | Nothing in this License shall be construed as excluding or limiting 556 | any implied license or other defenses to infringement that may 557 | otherwise be available to you under applicable patent law. 558 | 559 | 12. No Surrender of Others' Freedom. 560 | 561 | If conditions are imposed on you (whether by court order, agreement or 562 | otherwise) that contradict the conditions of this License, they do not 563 | excuse you from the conditions of this License. If you cannot convey a 564 | covered work so as to satisfy simultaneously your obligations under this 565 | License and any other pertinent obligations, then as a consequence you may 566 | not convey it at all. For example, if you agree to terms that obligate you 567 | to collect a royalty for further conveying from those to whom you convey 568 | the Program, the only way you could satisfy both those terms and this 569 | License would be to refrain entirely from conveying the Program. 570 | 571 | 13. Use with the GNU Affero General Public License. 572 | 573 | Notwithstanding any other provision of this License, you have 574 | permission to link or combine any covered work with a work licensed 575 | under version 3 of the GNU Affero General Public License into a single 576 | combined work, and to convey the resulting work. The terms of this 577 | License will continue to apply to the part which is the covered work, 578 | but the special requirements of the GNU Affero General Public License, 579 | section 13, concerning interaction through a network will apply to the 580 | combination as such. 581 | 582 | 14. Revised Versions of this License. 583 | 584 | The Free Software Foundation may publish revised and/or new versions of 585 | the GNU General Public License from time to time. Such new versions will 586 | be similar in spirit to the present version, but may differ in detail to 587 | address new problems or concerns. 588 | 589 | Each version is given a distinguishing version number. If the 590 | Program specifies that a certain numbered version of the GNU General 591 | Public License "or any later version" applies to it, you have the 592 | option of following the terms and conditions either of that numbered 593 | version or of any later version published by the Free Software 594 | Foundation. If the Program does not specify a version number of the 595 | GNU General Public License, you may choose any version ever published 596 | by the Free Software Foundation. 597 | 598 | If the Program specifies that a proxy can decide which future 599 | versions of the GNU General Public License can be used, that proxy's 600 | public statement of acceptance of a version permanently authorizes you 601 | to choose that version for the Program. 602 | 603 | Later license versions may give you additional or different 604 | permissions. However, no additional obligations are imposed on any 605 | author or copyright holder as a result of your choosing to follow a 606 | later version. 607 | 608 | 15. Disclaimer of Warranty. 609 | 610 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 611 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 612 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 613 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 614 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 615 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 616 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 617 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 618 | 619 | 16. Limitation of Liability. 620 | 621 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 622 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 623 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 624 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 625 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 626 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 627 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 628 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 629 | SUCH DAMAGES. 630 | 631 | 17. Interpretation of Sections 15 and 16. 632 | 633 | If the disclaimer of warranty and limitation of liability provided 634 | above cannot be given local legal effect according to their terms, 635 | reviewing courts shall apply local law that most closely approximates 636 | an absolute waiver of all civil liability in connection with the 637 | Program, unless a warranty or assumption of liability accompanies a 638 | copy of the Program in return for a fee. 639 | 640 | END OF TERMS AND CONDITIONS 641 | 642 | How to Apply These Terms to Your New Programs 643 | 644 | If you develop a new program, and you want it to be of the greatest 645 | possible use to the public, the best way to achieve this is to make it 646 | free software which everyone can redistribute and change under these terms. 647 | 648 | To do so, attach the following notices to the program. It is safest 649 | to attach them to the start of each source file to most effectively 650 | state the exclusion of warranty; and each file should have at least 651 | the "copyright" line and a pointer to where the full notice is found. 652 | 653 | {one line to give the program's name and a brief idea of what it does.} 654 | Copyright (C) {year} {name of author} 655 | 656 | This program is free software: you can redistribute it and/or modify 657 | it under the terms of the GNU General Public License as published by 658 | the Free Software Foundation, either version 3 of the License, or 659 | (at your option) any later version. 660 | 661 | This program is distributed in the hope that it will be useful, 662 | but WITHOUT ANY WARRANTY; without even the implied warranty of 663 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 664 | GNU General Public License for more details. 665 | 666 | You should have received a copy of the GNU General Public License 667 | along with this program. If not, see . 668 | 669 | Also add information on how to contact you by electronic and paper mail. 670 | 671 | If the program does terminal interaction, make it output a short 672 | notice like this when it starts in an interactive mode: 673 | 674 | {project} Copyright (C) {year} {fullname} 675 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 676 | This is free software, and you are welcome to redistribute it 677 | under certain conditions; type `show c' for details. 678 | 679 | The hypothetical commands `show w' and `show c' should show the appropriate 680 | parts of the General Public License. Of course, your program's commands 681 | might be different; for a GUI interface, you would use an "about box". 682 | 683 | You should also get your employer (if you work as a programmer) or school, 684 | if any, to sign a "copyright disclaimer" for the program, if necessary. 685 | For more information on this, and how to apply and follow the GNU GPL, see 686 | . 687 | 688 | The GNU General Public License does not permit incorporating your program 689 | into proprietary programs. If your program is a subroutine library, you 690 | may consider it more useful to permit linking proprietary applications with 691 | the library. If this is what you want to do, use the GNU Lesser General 692 | Public License instead of this License. But first, please read 693 | . 694 | Copy license text to clipboard 695 | How to apply this license 696 | 697 | Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. 698 | 699 | Note: The Free Software Foundation recommends taking the additional step of adding a boilerplate notice to the top of each file. The boilerplate can be found at the end of the license. 700 | 701 | Optional: Add GPL-3.0+ (or GPL-3.0 to disallow future versions) to your project's package description, if applicable (e.g., Node.js, Ruby, and Rust). This will ensure the license is displayed in package directories. 702 | 703 | Source 704 | Who's using this license? 705 | 706 | Bash 707 | GIMP 708 | Privacy Badger 709 | About Terms of Service The content of this site is licensed under the Creative Commons Attribution 3.0 Unported License. Curated with <3 by GitHub, Inc. and You! --------------------------------------------------------------------------------