├── requirements.txt ├── images ├── kofiLogo.png ├── add-API-key.png ├── patreonLogo.png ├── final-screen.png ├── API-key-screen.png ├── add-API-key-button-highlight.png ├── final-screen-api-key-highlight.png ├── API-key-screen-with-button-highlight.png └── final-screen-private-key-highlight.png ├── kraken_api_dca.py ├── .github ├── FUNDING.yml └── workflows │ └── workflow.yml ├── logger.py ├── price_calculation.py ├── trading_pairs.txt ├── .gitignore ├── README.md ├── order.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | krakenex==2.1.0 2 | -------------------------------------------------------------------------------- /images/kofiLogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/kofiLogo.png -------------------------------------------------------------------------------- /images/add-API-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/add-API-key.png -------------------------------------------------------------------------------- /images/patreonLogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/patreonLogo.png -------------------------------------------------------------------------------- /images/final-screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/final-screen.png -------------------------------------------------------------------------------- /images/API-key-screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/API-key-screen.png -------------------------------------------------------------------------------- /images/add-API-key-button-highlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/add-API-key-button-highlight.png -------------------------------------------------------------------------------- /images/final-screen-api-key-highlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/final-screen-api-key-highlight.png -------------------------------------------------------------------------------- /images/API-key-screen-with-button-highlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/API-key-screen-with-button-highlight.png -------------------------------------------------------------------------------- /images/final-screen-private-key-highlight.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bewagner/kraken_api_dca/HEAD/images/final-screen-private-key-highlight.png -------------------------------------------------------------------------------- /kraken_api_dca.py: -------------------------------------------------------------------------------- 1 | import krakenex 2 | 3 | from order import read_orders_from_file 4 | from logger import Logger 5 | if __name__ == "__main__": 6 | 7 | kraken = krakenex.API() 8 | kraken.load_key('kraken.key') 9 | logger = Logger("logs.txt") 10 | 11 | orders = read_orders_from_file(logger) 12 | for order in orders: 13 | order.place(kraken, logger) 14 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [bewagner] 4 | patreon: bewagner 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: bewagner 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /logger.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from datetime import date 3 | from pathlib import Path 4 | 5 | 6 | class Logger: 7 | """ 8 | Logger that prints to stdout and also writes to a file 9 | """ 10 | 11 | def __init__(self, log_file: str): 12 | self.__logs = "" 13 | self.__logging_date = date.today().strftime("%d.%m.%Y") 14 | self.__log_file = Path(log_file) 15 | 16 | if not self.__log_file.exists(): 17 | self.__log_file.touch() 18 | 19 | def __del__(self): 20 | """ 21 | Write the logs to the file at the end of the script (RAII style) 22 | """ 23 | if not self.__logs: 24 | return 25 | 26 | with self.__log_file.open("a") as log_file: 27 | log_file.write("\n\n") 28 | log_file.write(self.__logging_date) 29 | log_file.write(self.__logs) 30 | 31 | def log(self, s: str): 32 | """ 33 | Log a string. That is print it and add it to the string we print to the file at the end of the script. 34 | :param s: String to log 35 | """ 36 | self.__logs += "\n" + s 37 | print(s) 38 | 39 | def exit(self, s: str): 40 | """ 41 | Log a string and then exit execution 42 | :param s: String to log 43 | """ 44 | self.__logs += "\n" + s 45 | sys.exit(s) 46 | -------------------------------------------------------------------------------- /.github/workflows/workflow.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a single version of Python 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | 5 | name: Python package 6 | 7 | on: 8 | push: 9 | branches: [ main ] 10 | pull_request: 11 | branches: [ main ] 12 | 13 | jobs: 14 | build: 15 | 16 | runs-on: ubuntu-latest 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | python-version: [3.7, 3.8, 3.9] 21 | 22 | steps: 23 | - uses: actions/checkout@v2 24 | - name: Set up Python ${{ matrix.python-version }} 25 | uses: actions/setup-python@v2 26 | with: 27 | python-version: ${{ matrix.python-version }} 28 | - name: Install dependencies 29 | run: | 30 | python -m pip install --upgrade pip 31 | python -m pip install flake8 pytest 32 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 33 | - name: Lint with flake8 34 | run: | 35 | # stop the build if there are Python syntax errors or undefined names 36 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 37 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 38 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 39 | # - name: Test with pytest 40 | # run: | 41 | # pytest 42 | -------------------------------------------------------------------------------- /price_calculation.py: -------------------------------------------------------------------------------- 1 | from typing import Tuple 2 | 3 | 4 | def current_price(pair: str, kraken) -> float: 5 | """ 6 | Get the current price of a crypto trading pair from the Kraken API 7 | :param kraken: Handle to the Kraken API 8 | :param pair: Trading pair 9 | :return: Current price of the trading pair 10 | """ 11 | price_data = kraken.query_public('Ticker', data={'pair': pair}) 12 | if price_data['error']: 13 | raise ValueError(price_data['error'][0]) 14 | if pair not in price_data['result']: 15 | raise ValueError("Data extraction error") 16 | 17 | data = price_data['result'][pair]['a'] 18 | price = float(data[0]) 19 | if not price: 20 | raise ValueError("Data extraction error") 21 | 22 | return round_to_amount_of_decimals_kraken_accepts(price) 23 | 24 | 25 | def calculate_volume_from_price(fiat_volume: float, crypto_price: float) -> float: 26 | """ 27 | Calculate the order volume in crypto from a given fiat amount. 28 | Example: if crypto_price is 1000€ and your fiat_volume is 100€, the volume of your order can be 0.1 crypto. 29 | :param fiat_volume: Amount of fiat to spend. 30 | :param crypto_price: Current price of the crypto you want to buy 31 | :return: Calculated crypto volume 32 | """ 33 | volume = fiat_volume / crypto_price 34 | return volume 35 | 36 | 37 | def round_to_amount_of_decimals_kraken_accepts(number: float) -> float: 38 | """ 39 | Round to the number of decimals the Kraken API accepts 40 | :param number: Number to round 41 | :return: Rounded number 42 | """ 43 | # The Kraken API only accepts a single decimal 44 | number_of_accepted_decimals = 1 45 | return round(number, number_of_accepted_decimals) 46 | 47 | 48 | -------------------------------------------------------------------------------- /trading_pairs.txt: -------------------------------------------------------------------------------- 1 | ADAETH 2 | ADAEUR 3 | ADAUSD 4 | ADAXBT 5 | ALGOETH 6 | ALGOEUR 7 | ALGOUSD 8 | ALGOXBT 9 | ATOMETH 10 | ATOMEUR 11 | ATOMUSD 12 | ATOMXBT 13 | BATETH 14 | BATEUR 15 | BATUSD 16 | BATXBT 17 | BCHEUR 18 | BCHUSD 19 | BCHXBT 20 | DAIEUR 21 | DAIUSD 22 | DAIUSDT 23 | DASHEUR 24 | DASHUSD 25 | DASHXBT 26 | EOSETH 27 | EOSEUR 28 | EOSUSD 29 | EOSXBT 30 | ETHCHF 31 | ETHDAI 32 | ETHUSDC 33 | ETHUSDT 34 | EURCAD 35 | EURCHF 36 | EURGBP 37 | EURJPY 38 | GNOETH 39 | GNOEUR 40 | GNOUSD 41 | GNOXBT 42 | ICXETH 43 | ICXEUR 44 | ICXUSD 45 | ICXXBT 46 | LINKETH 47 | LINKEUR 48 | LINKUSD 49 | LINKXBT 50 | LSKETH 51 | LSKEUR 52 | LSKUSD 53 | LSKXBT 54 | NANOETH 55 | NANOEUR 56 | NANOUSD 57 | NANOXBT 58 | OMGETH 59 | OMGEUR 60 | OMGUSD 61 | OMGXBT 62 | PAXGETH 63 | PAXGEUR 64 | PAXGUSD 65 | PAXGXBT 66 | QTUMETH 67 | QTUMEUR 68 | QTUMUSD 69 | QTUMXBT 70 | SCETH 71 | SCEUR 72 | SCUSD 73 | SCXBT 74 | TRXETH 75 | TRXEUR 76 | TRXUSD 77 | TRXXBT 78 | USDCEUR 79 | USDCHF 80 | USDCUSD 81 | USDCUSDT 82 | USDTCAD 83 | USDTEUR 84 | USDTGBP 85 | USDTZUSD 86 | WAVESETH 87 | WAVESEUR 88 | WAVESUSD 89 | WAVESXBT 90 | XBTCHF 91 | XBTDAI 92 | XBTUSDC 93 | XBTUSDT 94 | XDGEUR 95 | XDGUSD 96 | XETCXETH 97 | XETCXXBT 98 | XETCZEUR 99 | XETCZUSD 100 | XETHXXBT 101 | XETHZCAD 102 | XETHZEUR 103 | XETHZGBP 104 | XETHZJPY 105 | XETHZUSD 106 | XLTCXXBT 107 | XLTCZEUR 108 | XLTCZUSD 109 | XMLNXETH 110 | XMLNXXBT 111 | XMLNZEUR 112 | XMLNZUSD 113 | XREPXETH 114 | XREPXXBT 115 | XREPZEUR 116 | XREPZUSD 117 | XTZETH 118 | XTZEUR 119 | XTZUSD 120 | XTZXBT 121 | XXBTZCAD 122 | XXBTZEUR 123 | XXBTZGBP 124 | XXBTZJPY 125 | XXBTZUSD 126 | XXDGXXBT 127 | XXLMXXBT 128 | XXLMZEUR 129 | XXLMZUSD 130 | XXMRXXBT 131 | XXMRZEUR 132 | XXMRZUSD 133 | XXRPXXBT 134 | XXRPZCAD 135 | XXRPZEUR 136 | XXRPZJPY 137 | XXRPZUSD 138 | XZECXXBT 139 | XZECZEUR 140 | XZECZUSD 141 | ZEURZUSD 142 | ZGBPZUSD 143 | ZUSDZCAD 144 | ZUSDZJPY 145 | -------------------------------------------------------------------------------- /.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 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | 132 | kraken.key 133 | .idea/ 134 | logs.txt 135 | orders.json 136 | 137 | test.py 138 | test_logs.txt 139 | 140 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kraken API Dollar cost averaging script 2 | 3 | Hi! If you're looking for a way to automate your regular crypto purchases via [Kraken](https://www.kraken.com/), you 4 | have come to the right place. The `kraken_api_dca.py` script allows you to specify orders in all trading pairs on 5 | Kraken. Just let your computer run the script at regular intervals and you have your 6 | automated [Dollar cost averaging](https://en.wikipedia.org/wiki/Dollar_cost_averaging) bot. 7 | 8 | [![Python package](https://github.com/bewagner/kraken_api_dca/actions/workflows/workflow.yml/badge.svg?branch=main)](https://github.com/bewagner/kraken_api_dca/actions/workflows/workflow.yml) 9 | 10 | # Support 11 | 12 | If this code is useful to you, consider supporting me! This way I can continue maintaining and improving your DCA 13 | script. 14 | 15 | [comment]: <> ([![Ko-fi logo](/images/kofiLogo.png|width=100)](bla) [![Patreon logo](/images/patreonLogo.png|width=100)]()) 16 | 17 | [](https://ko-fi.com/bewagner)         18 | [](https://www.patreon.com/bewagner?fan_landing=true) 19 | 20 | # Dependencies 21 | 22 | This script needs the `krakenex` pip package. To install it run 23 | 24 | ```commandline 25 | pip install -r requirements.txt 26 | ``` 27 | 28 | # Usage 29 | 30 | To use the script, you need to: 31 | 32 | - Create a Kraken API key and save it to the file `kraken.key`. 33 | [See here for an explanation.](#kraken-api-key) 34 | - Create a file `orders.json` and specify your orders. 35 | . [See this description of how to place your orders.](#specifying-your-orders) 36 | - Run the script via `python3 kraken_api_dca.py` 37 | 38 | ## Kraken API key 39 | 40 | To use this script, you need a Kraken API key that allows creating orders. 41 | 42 | Below we explain how to create an API key if you don't have one already. 43 | 44 | ### How to create an API key 45 | 46 | To create your API key, click on your profile icon. Then go to `Security->API`. You will see the following screen. 47 | 48 | ![API key screen](/images/API-key-screen.png) 49 | 50 | Click on 'Add key' to add a new API key. 51 | 52 | ![API key screen with 'add key' button highlighted](/images/API-key-screen-with-button-highlight.png) 53 | This will take you to the next screen. 54 | 55 | ![API creation screen which allows choosing the API key rights](/images/add-API-key.png) 56 | 57 | Make sure you check **Create & Modify Orders**. 58 | 59 | You should not check any other fields. Especially **not** 'Withdraw Funds', as this would allow people with access to 60 | your API key to withdraw your funds. 61 | 62 | Then click on 'Generate key'. 63 | 64 | ![API creation screen which allows choosing the API key rights, with highlight on 'generate key' button.](/images/add-API-key-button-highlight.png) 65 | 66 | This creates your key and takes you to the next screen. Here you see your public and private key. This is the 67 | information you have to store in the `kraken.key` file. 68 | 69 | ![API creation screen](/images/final-screen.png) 70 | Copy the information from the 'API key' line and write it into the first line in `kraken.key`. 71 | ![API creation screen with highlight on API key](/images/final-screen-api-key-highlight.png) 72 | 73 | Then copy the private key and save it in the second line of `kraken.key`. 74 | 75 | ![API creation screen with highlight on private key](/images/final-screen-private-key-highlight.png) 76 | 77 | Finally, click 'Save.' 78 | 79 | Your `kraken.key` file should look like this. 80 | 81 | ```text 82 | 83 | 84 | ``` 85 | 86 | ## Specifying your orders 87 | 88 | To specify your orders, create a file called `orders.json`. The file should contain a list of orders in JSON format. 89 | Each order object can contain the following fields: 90 | 91 | - `pair (string)`: The trading pair you want to buy (for example `ALGOUSD` for trading Algorand for US$). Have a look 92 | at `trading_pairs.txt` for an overview of all trading pairs. Note that Bitcoin is called `XBT`. 93 | - `amount_in_fiat (number)`: The amount you want to buy (in fiat currency). E.g. if you want to buy 400$ of Bitcoin, 94 | enter `400` and choose the `XXBTZUSD` trading pair. 95 | - `debug (boolean)`: This gives you the possibility to test the script before you let it place orders for you. If you 96 | set `debug:true` the order will be placed as a limit order for 1% of the current price. This is, so you can verify 97 | that the order is created and delete the order before it is executed. After you checked that everything worked, 98 | set `debug:false` for all your orders. 99 | 100 | An example `orders.json` could look like this: 101 | 102 | ```json5 103 | [ 104 | { 105 | "pair": "XETHZUSD", 106 | "amount_in_fiat": 100, 107 | "debug": true 108 | }, 109 | { 110 | "pair": "XXBTZUSD", 111 | "amount_in_fiat": 200, 112 | "debug": true 113 | } 114 | ] 115 | ``` 116 | 117 | This would create two orders. The first order buys 100$ of Ether, the second order buys 200$ of Bitcoin. Both orders 118 | have debug mode activated, which means they will be placed as limit orders on 1% of the current price. This way you can 119 | check that everything works out, delete the created orders and set `debug:false` once you want to start using the 120 | script. 121 | 122 | ## How can you automate calling the script 123 | 124 | ### Linux 125 | 126 | On Linux you can use `anacron` to schedule execution of the script. To run the script monthly, you can add the following 127 | line to `/etc/anacrontab`: 128 | 129 | ```text 130 | @monthly 7 kraken-api-dca-script cd ~/kraken_api_dca && python3 ~/kraken_api_dca/kraken_api_dca.py 131 | ``` 132 | 133 | `anacron` has the advantage over `cron` that if your computer is turned off, the script will be executed the next time 134 | the computer is turned on. 135 | [See here](https://kifarunix.com/scheduling-tasks-using-anacron-in-linux-unix/) for more information on `anacron`. 136 | 137 | ### Windows 138 | 139 | On Windows you could try the following library to schedule script execution: 140 | [Advanced Python Scheduler](https://apscheduler.readthedocs.io/en/stable/) 141 | (Note: I couldn't test this, since I don't have a Windows machine) 142 | 143 | ## Logging 144 | 145 | The script will write logs to a file called `logs.txt`. Check this file for the results of your API calls. 146 | 147 | # Use at your own risk 148 | 149 | This code is correct to the best of my knowledge and belief. If you decide to use it, you do so at your own risk. I will 150 | not be liable for any losses or damages in connection with using my code. 151 | 152 | -------------------------------------------------------------------------------- /order.py: -------------------------------------------------------------------------------- 1 | import json 2 | from enum import Enum 3 | from pathlib import Path 4 | from typing import List 5 | 6 | from logger import Logger 7 | from price_calculation import current_price, round_to_amount_of_decimals_kraken_accepts, calculate_volume_from_price 8 | 9 | 10 | class OrderStyle(Enum): 11 | buy = 1 12 | sell = 2 13 | 14 | 15 | class OrderType(Enum): 16 | market = 1 17 | limit = 2 18 | 19 | 20 | class Order: 21 | def __init__(self, pair: str, 22 | amount_in_fiat: int, 23 | debug: bool, 24 | order_style: OrderStyle = OrderStyle.buy, 25 | order_type: OrderType = OrderType.limit, 26 | ): 27 | self.pair = pair 28 | self.amount_in_fiat = amount_in_fiat 29 | self.order_style = order_style 30 | self.order_type = order_type 31 | self.debug = debug 32 | 33 | def __repr__(self): 34 | return f"[pair: {self.pair}, amount_in_fiat: {self.amount_in_fiat}, debug: {self.debug}]" 35 | 36 | def place(self, kraken, logger: Logger): 37 | """ 38 | Place an order via the Kraken API 39 | :param logger: Logger to write logging strings to 40 | :param kraken: Handle to the Kraken API 41 | """ 42 | logger.log(f"Start placing order {self}") 43 | order_string = f"ORDER: pair: {self.pair}, " \ 44 | f"amount in fiat: {self.amount_in_fiat}, " \ 45 | f"style: {self.order_style.name}, " \ 46 | f"type: {self.order_type.name}" 47 | 48 | try: 49 | current_crypto_price = current_price(self.pair, kraken) 50 | except ValueError as exception: 51 | if "Unknown asset pair" in exception.args[0]: 52 | logger.exit(order_string 53 | + "\n" 54 | f"ERROR: You specified an unknown trading pair: {self.pair}" 55 | f"\nSee here for a full list of all trading pairs " 56 | f"https://support.kraken.com/hc/en-us/articles/360000920306-Ticker-pairs#:~:text=" 57 | f"A%20Ticker%20is%20a%20report,example%20the%20trading%20pair%20BTCEUR.&text=" 58 | f"This%20Ticker%20example%20will%20pull,re%20deployed%20to%20our%20platform.") 59 | 60 | if "Data extraction error" in exception.args[0]: 61 | logger.exit(order_string + "\nERROR: There was an error while extracting data from the Kraken API.") 62 | 63 | logger.exit(order_string + f"ERROR: {exception.args}") 64 | 65 | current_crypto_price = round(current_crypto_price, 5) 66 | 67 | # In debug mode, we set a limit order at 1% of the current price. 68 | # This way the user can check if everything works and cancel their order later. 69 | debug_multiplier = 1 70 | if self.debug: 71 | self.order_type = OrderType.limit 72 | debug_multiplier = 0.01 73 | 74 | order_price = round_to_amount_of_decimals_kraken_accepts(current_crypto_price * debug_multiplier) 75 | response = kraken.query_private('AddOrder', 76 | {'pair': self.pair, 77 | 'type': self.order_style.name, 78 | 'ordertype': self.order_type.name, 79 | 'price': order_price, 80 | 'volume': calculate_volume_from_price(self.amount_in_fiat, 81 | current_crypto_price), 82 | 'trading_agreement': 'agree' 83 | }) 84 | if response['error']: 85 | errors = response['error'] 86 | 87 | if any("Invalid arguments:volume" in e for e in errors): 88 | logger.exit(order_string 89 | + "\nERROR: The volume you specified for your order was invalid.\n" 90 | "This probably means the specified fiat amount was too low.\n" 91 | "See https://support.kraken.com/hc/en-us/articles/" 92 | "205893708-Minimum-order-size-volume-for-trading " 93 | "for the minimum required order sizes.") 94 | if any("Insufficient funds" in e for e in errors): 95 | logger.exit(order_string 96 | + "\nERROR: Insufficient funds. " 97 | "Your Kraken account does not contain enough funds for this order.") 98 | 99 | logger.exit(order_string + f"ERROR: {errors}") 100 | 101 | logger.log(f"Placed order: {self}\n") 102 | 103 | 104 | def read_orders_from_file(logger: Logger) -> List[Order]: 105 | """ 106 | Read orders from the orders.json file. 107 | Also, make sure they are formatted correctly and check the value types. 108 | :param logger: Logger to write logging strings to 109 | :return: Orders read from file 110 | """ 111 | orders_file = Path("orders.json") 112 | if not orders_file.exists(): 113 | logger.exit("ERROR: Couldn't find an order file orders.json. " 114 | "Make sure this file exists in the same directory as kraken_api_dca.py") 115 | try: 116 | orders_file_content = orders_file.open("r").read() 117 | except Exception as e: 118 | logger.exit(f"ERROR: There was an error while reading the orders file.\n{e}") 119 | try: 120 | orders_json = json.loads(orders_file_content) 121 | except json.JSONDecodeError as e: 122 | logger.exit(f"ERROR: There was an error while decoding your orders file. " 123 | f"Please make sure you wrote valid JSON.\n{e}") 124 | 125 | orders = [] 126 | for order in orders_json: 127 | def check_parameter(parameter: str, desired_type): 128 | if parameter not in order or not isinstance(order[parameter], desired_type): 129 | logger.exit(f"ERROR: Your order\n{order}\ndid not contain a valid value for '{parameter}'." 130 | "\nMake sure your JSON input in orders.json is correct.") 131 | 132 | check_parameter("pair", str) 133 | check_parameter("amount_in_fiat", (float, int)) 134 | check_parameter("debug", bool) 135 | 136 | orders.append(Order(pair=order["pair"], amount_in_fiat=order["amount_in_fiat"], debug=order["debug"])) 137 | 138 | if orders: 139 | logger.log("Read the following orders from the orders.json file:") 140 | for order in orders: 141 | logger.log(f"\t- {order}") 142 | 143 | return orders 144 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------