├── requirements.txt ├── comdirect_api ├── __init__.py ├── utils.py ├── types.py └── session.py ├── .gitignore ├── .stickler.yml ├── doc └── comdirect_REST_API_Dokumentation.pdf ├── pyproject.toml ├── AUTHORS ├── MANIFEST.in ├── setup.cfg ├── bin ├── download_all_documents.py ├── get_account_balances_and_transactions.py └── get_depot_data.py ├── tox.ini ├── setup.py ├── README.md └── COPYING /requirements.txt: -------------------------------------------------------------------------------- 1 | datetime 2 | pillow 3 | requests 4 | uuid 5 | -------------------------------------------------------------------------------- /comdirect_api/__init__.py: -------------------------------------------------------------------------------- 1 | # This file is intentionally empty. 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .tox/ 3 | *.egg-info 4 | dist/ 5 | bin/creds.py 6 | build/ 7 | -------------------------------------------------------------------------------- /.stickler.yml: -------------------------------------------------------------------------------- 1 | linters: 2 | flake8: 3 | fixer: true 4 | max-line-length: 120 5 | 6 | fixers: 7 | enable: true 8 | -------------------------------------------------------------------------------- /doc/comdirect_REST_API_Dokumentation.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keisentraut/python-comdirect-api/HEAD/doc/comdirect_REST_API_Dokumentation.pdf -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | # These are the assumed default build requirements from pip: 3 | # https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support 4 | requires = ["setuptools>=40.8.0", "wheel"] 5 | build-backend = "setuptools.build_meta" 6 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | keisentraut (Klaus Eisentraut) 2 | - idea and meta-work on module structure 3 | - DOCUMENTS 4 | - ACCOUNTS 5 | 6 | sebanger 7 | - excel output (unfortunately, this did not survive refactoring so far) 8 | 9 | squisher23 10 | - add pushtan (typ = P_TAN_PUSH) as second factor 11 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include pyproject.toml 2 | include COPYING 3 | include AUTHORS 4 | include README.md 5 | include requirements.txt 6 | 7 | recursive-include comdirect_api *.py 8 | recursive-include bin *.py 9 | recursive-include doc *.pdf 10 | 11 | exclude .stickler.yml 12 | exclude tox.ini 13 | exclude bin/creds.py 14 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | # This includes the license file(s) in the wheel. 3 | # https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file 4 | license_files = COPYING 5 | 6 | [bdist_wheel] 7 | # This flag says to generate wheels that support both Python 2 and Python 8 | # 3. If your code will not run unchanged on both Python 2 and 3, you will 9 | # need to generate separate wheels for each Python version that you 10 | # support. Removing this line (or setting universal to 0) will prevent 11 | # bdist_wheel from trying to make a universal wheel. For more see: 12 | # https://packaging.python.org/guides/distributing-packages-using-setuptools/#wheels 13 | universal=0 14 | -------------------------------------------------------------------------------- /comdirect_api/utils.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import io 3 | 4 | 5 | def is_alphanum(c): 6 | ALPHANUM = set( 7 | "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789.,-äüöÄÜÖß") 8 | return c in ALPHANUM 9 | 10 | 11 | def make_printable(s): 12 | return "".join([i if is_alphanum(i) else "_" for i in s]) 13 | 14 | 15 | def timestamp(): 16 | return datetime.datetime.now(datetime.timezone.utc).strftime("%Y%m%d%H%M%S%f") 17 | 18 | 19 | def is_valid_TAN(tan): 20 | return type(tan) == str and len(tan) == 6 and set(tan) <= set("0123456789") 21 | 22 | 23 | def default_callback_p_tan(pngImage): 24 | from PIL import Image 25 | 26 | Image.open(io.BytesIO(pngImage)).show() 27 | p_tan = input("Please enter Photo-TAN: ") 28 | if not is_valid_TAN(p_tan): 29 | raise ValueError(f"invalid Photo-TAN {p_tan}") 30 | return p_tan 31 | 32 | 33 | def default_callback_m_tan(): 34 | m_tan = input("Please enter your SMS-TAN: ") 35 | if not is_valid_TAN(m_tan): 36 | raise ValueError(f"invalid SMS-TAN {m_tan}") 37 | return m_tan 38 | 39 | 40 | def default_callback_p_tan_push(): 41 | m_tan = input("Please press ENTER after confirming push-tan ") 42 | m_tan = "123456" 43 | return m_tan 44 | -------------------------------------------------------------------------------- /bin/download_all_documents.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from comdirect_api.session import Session 3 | from creds import user, password, client_id, client_secret 4 | import os 5 | import sys 6 | 7 | # During development, you can store your credentials in bin/creds.py. 8 | # Just put something like the following there: 9 | # user = "XXXXXXXX" 10 | # password = "XXXXXX" 11 | # client_id = "User_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 12 | # client_secret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 13 | # Alternatively, just hard-code them here. 14 | 15 | # Define directory to store documents in (or leave emtpy) 16 | # Alternatively, you can use a script parameter 17 | if len(sys.argv) == 2: 18 | PATH = os.path.dirname(sys.argv[1]) 19 | else: 20 | print(f"usage: {sys.argv[0]} PATH") 21 | 22 | # This downloads all documents (pagingcount defines the number of 23 | # documents per page 24 | pagingcount = 50 25 | 26 | s = Session(user, password, client_id, client_secret) 27 | pagingfirst = 0 28 | hasmore = True 29 | 30 | while hasmore: 31 | count = 0 32 | for d in s.documents_list(paging_count=pagingcount, paging_first=pagingfirst): 33 | count += 1 34 | filename = d.get_filename() 35 | print(f"downloading document {pagingfirst +count} {filename}...") 36 | content = s.documents_download(d) 37 | 38 | with open(os.path.join(PATH, filename), "wb") as f: 39 | f.write(content) 40 | hasmore = count == pagingcount 41 | if hasmore: 42 | print(f"fetching next page of documents {pagingfirst+pagingcount} to {pagingfirst+pagingcount*2}") 43 | pagingfirst += pagingcount 44 | else: 45 | print(f"finished fetching {pagingfirst + count} documents ") 46 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # this file is *not* meant to cover or endorse the use of tox or pytest or 2 | # testing in general, 3 | # 4 | # It's meant to show the use of: 5 | # 6 | # - check-manifest 7 | # confirm items checked into vcs are in your sdist 8 | # - python setup.py check 9 | # confirm required package meta-data in setup.py 10 | # - readme_renderer (when using a ReStructuredText README) 11 | # confirms your long_description will render correctly on PyPI. 12 | # 13 | # and also to help confirm pull requests to this project. 14 | 15 | [tox] 16 | envlist = py3 17 | 18 | # Define the minimal tox version required to run; 19 | # if the host tox is less than this the tool with create an environment and 20 | # provision it with a tox that satisfies it under provision_tox_env. 21 | # At least this version is needed for PEP 517/518 support. 22 | minversion = 3.3.0 23 | 24 | # Activate isolated build environment. tox will use a virtual environment 25 | # to build a source distribution from the source tree. For build tools and 26 | # arguments use the pyproject.toml file as specified in PEP-517 and PEP-518. 27 | isolated_build = true 28 | 29 | [testenv] 30 | deps = 31 | check-manifest 32 | # If your project uses README.rst, uncomment the following: 33 | # readme_renderer 34 | flake8 35 | pytest 36 | commands = 37 | check-manifest --ignore tox.ini,tests* 38 | # This repository uses a Markdown long_description, so the -r flag to 39 | # `setup.py check` is not needed. If your project contains a README.rst, 40 | # use `python setup.py check -m -r -s` instead. 41 | python setup.py check -m -s 42 | flake8 . 43 | #py.test tests {posargs} 44 | 45 | [flake8] 46 | exclude = .tox,*.egg,build,data,comdirect_api/old/ 47 | select = E,W,F 48 | max-line-length = 119 49 | # F841 local variable 'bpid' is assigned to but never used 50 | #ignore = F841 51 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | from os import path 4 | here = path.abspath(path.dirname(__file__)) 5 | 6 | # Get the long description from the README file 7 | with open(path.join(here, "README.md"), encoding="utf-8") as f: 8 | long_description = f.read() 9 | 10 | setup( 11 | name="comdirect_api", 12 | version="0.1", 13 | description="Python module for comdirect REST api", 14 | long_description=long_description, 15 | long_description_content_type="text/markdown", 16 | url="https://github.com/keisentraut/python-comdirect-api", 17 | author="Klaus Eisentraut", 18 | author_email="klaus-python-comdirect-api@hohenpoelz.de", 19 | classifiers=[ 20 | "Development Status :: 3 - Alpha", 21 | "Intended Audience :: Developers", 22 | "Topic :: Software Development :: Build Tools", 23 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 24 | "Programming Language :: Python :: 3", 25 | "Programming Language :: Python :: 3.6", 26 | "Programming Language :: Python :: 3.7", 27 | "Programming Language :: Python :: 3.8", 28 | ], 29 | keywords="comdirect rest api", 30 | packages=["comdirect_api"], 31 | python_requires=">=3.6", 32 | install_requires=[ 33 | # TODO: I am not sure if those packages are installed by default or not. 34 | # For now, I just uncommented them, too lazy for a proper test... 35 | # "base64", 36 | "datetime", 37 | # "decimal", 38 | # "io", 39 | # "json", 40 | "pillow", 41 | "requests", 42 | # "time", 43 | "uuid", 44 | ], 45 | project_urls={ 46 | "Bug Reports": "https://github.com/keisentraut/python-comdirect-api/issues", 47 | # 'Funding': 'https://donate.pypi.org', 48 | # 'Say Thanks!': 'http://saythanks.io/to/example', 49 | "Source": "https://github.com/keisentraut/python-comdirect-api/", 50 | }, 51 | ) 52 | -------------------------------------------------------------------------------- /bin/get_account_balances_and_transactions.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # During development, you can store your credentials in bin/creds.py. 4 | # Just put something like the following there: 5 | # user = "XXXXXXXX" 6 | # password = "XXXXXX" 7 | # client_id = "User_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 8 | # client_secret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 9 | # Alternatively, just hard-code them here. 10 | from creds import user, password, client_id, client_secret 11 | 12 | from comdirect_api.session import Session 13 | 14 | import datetime 15 | 16 | 17 | def compress_duplicate_spaces(s): 18 | s = str(s) 19 | while " " in s: 20 | s = s.replace(" ", " ") 21 | return s 22 | 23 | 24 | # This shows the balances of your (first 1000) accounts 25 | s = Session(user, password, client_id, client_secret) 26 | for account_balance in s.account_get_balances(): 27 | account = account_balance.account 28 | balance = account_balance.balance 29 | print(f"Balance of {account}: {balance}") 30 | accountId = account.accountId 31 | print("Recent transactions:") 32 | transactions = s.account_get_transactions( 33 | accountId, 34 | # TODO: comdirect has not implemented this. 35 | # see https://community.comdirect.de/t5/Website-Apps/Rest-API-Filter-Parameter/m-p/108710 36 | min_bookingdate=(datetime.date.today() - datetime.timedelta(days=180)).strftime("%Y-%m-%d"), 37 | max_bookingdate=(datetime.date.today()).strftime("%Y-%m-%d"), 38 | ) 39 | for t in transactions: 40 | if t.bookingDate is None: 41 | t.bookingDate = "XXXX-XX-XX" 42 | print(f" {t.bookingDate} {t.valutaDate} {t.amount} {t.transactionType}\n" 43 | f" Reference: {compress_duplicate_spaces(t.reference)}\n" 44 | f" RemittanceInfo: {compress_duplicate_spaces(t.remittanceInfo)}\n" 45 | f" EndToEndReference: {compress_duplicate_spaces(t.endToEndReference)}\n") 46 | print() 47 | 48 | # This API call gets a single account balance, but you need to know the accountid in advance. 49 | # So it's kinda useless in reality. 50 | # print(s.account_get_balance(b.account.accountId)) 51 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # python-comdirect-api 2 | 3 | This is a Python implementation of the new [comdirect REST API](https://www.comdirect.de/cms/kontakt-zugaenge-api.html). This API can be used to interact with the German bank comdirect and view your balances and transactions. The technical specification of the API (in German) is found [here](https://kunde.comdirect.de/cms/media/comdirect_REST_API_Dokumentation.pdf). 4 | 5 | Currently, only parts of this comdirect API are implemented. 6 | Parts which are already implemented and work: 7 | 8 | - OAuth 2-factor login process (Photo-TAN, Push-TAN, SMS-TAN) 9 | - DOCUMENTS 10 | - ACCOUNT (balances & transactions) 11 | 12 | Still to do: 13 | 14 | - QUOTE 15 | - ORDER 16 | - INSTRUMENT 17 | - DEPOT 18 | 19 | Most likely, I won't implement those soon, this has two reasons: 20 | 21 | - comdirect does not provide test accounts for creating transactions, so I would have to test it on my actual private savings which is crazy. 22 | - I don't want to write a trading bot, so I don't have a need for this. 23 | 24 | 25 | 26 | # How to use this 27 | 28 | This Python module is currently not yet on PyPi (and given the stalled development, probably never will be). 29 | So in order to build it, you need to clone this repository and then package it yourself: 30 | 31 | ``` 32 | python setup.py sdist 33 | pip install dist/comdirect_api-0.1.tar.gz 34 | ``` 35 | 36 | After installing it, you can run one of the scripts in the ```bin``` folder or write your own script. 37 | 38 | ``` 39 | $ python bin/get_account_balances_and_transactions.py 40 | Please enter Photo-TAN: 123456 41 | Balance of Direct Access Savings-Plus Account (DE012345678901234567890): 0 EUR 42 | Recent transactions: 43 | 2019-09-11 2019-09-11 -3000.15 EUR TRANSFER 44 | Reference: I2219254G2705657/2 45 | RemittanceInfo: 01Uebertrag auf Girokonto 02End-to-End-Ref.: 03nicht angegeben 46 | EndToEndReference: nicht angegeben 47 | 48 | 49 | Balance of Checking Account (DE09876543210987654321): 1234.56 EUR 50 | Recent transactions: 51 | 2020-01-03 2020-01-03 -12.34 EUR DIRECT_DEBIT 52 | Reference: 5012345678901234/12345 53 | RemittanceInfo: 01Globus TS Forchheim//Forchheim/DE 022020-01-03T20:07:16 KFN 0 VJ 1234 54 | EndToEndReference: None 55 | [... snip ...] 56 | ``` 57 | 58 | # Disclaimer 59 | 60 | *Use at own risk. I'm not responsible if you lock your account or lose all your money.* 61 | 62 | 63 | # Contributing 64 | 65 | Contributions are very welcome. Please open a pull request. 66 | Before you commit, run ```flake8 --max-line-length 120``` in order to check for code style. 67 | There is also a file ```tox.ini```, but there are no unit tests yet. 68 | I can't really create unit tests because there comdirect does not offer any public test accounts. 69 | 70 | ## Dependencies 71 | 72 | This module needs the following packages. 73 | 74 | ``` 75 | base64 76 | datetime 77 | decimal 78 | io 79 | json 80 | pillow 81 | requests 82 | time 83 | uuid 84 | ``` 85 | -------------------------------------------------------------------------------- /bin/get_depot_data.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # During development, you can store your credentials in bin/creds.py. 4 | # Just put something like the following there: 5 | # user = "XXXXXXXX" 6 | # password = "XXXXXX" 7 | # client_id = "User_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 8 | # client_secret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 9 | # Alternatively, just hard-code them here. 10 | 11 | from creds import user, password, client_id, client_secret 12 | from comdirect_api.session import Session 13 | 14 | import json 15 | import sys 16 | 17 | out_path = sys.argv[1] if len(sys.argv) == 2 else None 18 | 19 | s = Session(user, password, client_id, client_secret) 20 | 21 | depots = s.account_get_depots() 22 | if not depots: 23 | print("No depots found.") 24 | sys.exit(0) 25 | 26 | output = {"depots": []} 27 | 28 | for idx, depot in enumerate(depots, start=1): 29 | print(f"\n[{idx}] Depot {depot.depotDisplayId or depot.depotId}") 30 | 31 | # Use session method to get aggregated values 32 | balance, positions = None, None 33 | try: 34 | balance, positions = s.account_get_depot_positions(depot.depotId) 35 | if balance: 36 | print("Summary:") 37 | print(f"\t Previous Day Value: {balance.prevDayValue} EUR") 38 | print(f"\t Current Value : {balance.currentValue} EUR") 39 | print(f"\t Purchase Value : {balance.purchaseValue} EUR") 40 | print(f"\t Profit Since Buy : {balance.profitSincePurchase} EUR") 41 | print(f"\t 1-day Performance : {balance.profitLossPrevDayRel} %") 42 | print(f"\t Total Performance : {balance.profitLossPurchaseRel} %") 43 | 44 | except Exception as e: 45 | print(f"Failed to fetch depot data: {e}") 46 | 47 | if positions: 48 | print(f"Positions ({len(positions)}):") 49 | for i, pos in enumerate(positions, start=1): 50 | 51 | print(f"\t {i:>2}. WKN {pos.wkn}") 52 | print(f"\t\t Qty: {pos.qty} | Current: {pos.currentValue} EUR | Purchase: {pos.purchaseValue} EUR") 53 | print(f"\t\t Total P/L: {pos.profitLossPurchaseAbs} EUR | Total P/L {pos.profitLossPurchaseRel} % | 1-day P/L: {pos.profitLossPrevDayRel} %") 54 | else: 55 | print("\t No positions found.") 56 | 57 | # Collect JSON output for this depot 58 | output["depots"].append({ 59 | "depotId": depot.depotId, 60 | "depotDisplayId": depot.depotDisplayId, 61 | "holderName": depot.holderName, 62 | "aggregated": None if not balance else { 63 | "prevDayValue": balance.prevDayValue, 64 | "currentValue": balance.currentValue, 65 | "purchaseValue": balance.purchaseValue, 66 | "profitSincePurchase": balance.profitSincePurchase, 67 | "profitLossPrevDayRel": balance.profitLossPrevDayRel, 68 | "profitLossPurchaseRel": balance.profitLossPurchaseRel, 69 | }, 70 | "positions": [] if not positions else [ 71 | { 72 | "wkn": p.wkn, 73 | "quantity": p.qty, 74 | "currentValue": p.currentValue, 75 | "purchaseValue": p.purchaseValue, 76 | "profitLossPurchaseAbs": p.profitLossPurchaseAbs, 77 | "profitLossPurchaseRel": p.profitLossPurchaseRel, 78 | "profitLossPrevDayAbs": p.profitLossPrevDayAbs, 79 | "profitLossPrevDayRel": p.profitLossPrevDayRel, 80 | } 81 | for p in positions 82 | ], 83 | }) 84 | 85 | # Save JSON if an output path was provided 86 | if out_path: 87 | try: 88 | with open(out_path, "w", encoding="utf-8") as f: 89 | json.dump(output, f, ensure_ascii=False, indent=2) 90 | print(f"Saved JSON to {out_path}") 91 | except Exception as e: 92 | print(f"Failed to save JSON: {e}") -------------------------------------------------------------------------------- /comdirect_api/types.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import comdirect_api.utils 3 | from decimal import Decimal 4 | 5 | 6 | class DateString(): 7 | """init from YYYY-MM-DD""" 8 | 9 | def __init__(self, s): 10 | self.date = datetime.datetime.strptime(s, "%Y-%m-%d").date() 11 | 12 | def __str__(self): 13 | return self.date.strftime("%Y-%m-%d") 14 | 15 | 16 | # --------------------------- ACCOUNT ----------------------------------------- 17 | 18 | AccountType = { 19 | "FX": "Foreign Currency Account", 20 | "OF": "Options- & Futures Trading Account", 21 | "CA": "Checking Account", 22 | "DAS": "Direct Access Savings-Plus Account", 23 | "CFD": "Contract for Difference Account", 24 | "SA": "Settlement Account", 25 | "LLA": "Lombard Loan Account", 26 | } 27 | 28 | # TODO: This list is incomplete. 29 | TransactionType = { 30 | "ATM_WITHDRAWAL": "ATM Withdrawal", 31 | "DIRECT_DEBIT": "Direct Debit", 32 | "SECURITIES": "Securities", 33 | "TRANSFER": "Transfer", 34 | "INTEREST_DIVIDENDS": "Interest Dividends", 35 | "BANK_FEES": "Bank fees", 36 | "UNKNOWN": "Unknown", # this happens with unbooked transactions 37 | "XX1": "Saving Plan", 38 | "XX2": "Investment Saving", 39 | "XX3": "Bank fees", 40 | "XX4": "Miscellaneous", 41 | "XX5": "Cash", 42 | "XX6": "Interest / Dividends", 43 | "XX7": "Currency Exchange", 44 | "XX8": "Cancellation", 45 | "XX9": "Card Transaction", 46 | "XXA": "Foreign Currency exchange", 47 | "XXB": "ATM Withdrawal", 48 | "XXC": "Savings", 49 | "XXD": "Standing Order", 50 | } 51 | 52 | 53 | class AmountValue(): 54 | """ create from JSON REST response 55 | 56 | Example input will look like the following: 57 | {'unit':'EUR', 'value': '123.45'} 58 | """ 59 | 60 | def __init__(self, json): 61 | self.unit = json["unit"] 62 | self.value = Decimal(json["value"]) 63 | 64 | def get_amount(self): 65 | return self.value 66 | 67 | def __str__(self): 68 | return f"{self.value} {self.unit}" 69 | 70 | 71 | class Account(): 72 | """ create from JSON REST response 73 | 74 | Example input will look like the following: 75 | {'accountDisplayId': '12345678901', 76 | 'accountId': '148B8582CFB8F2C0CB8D3E56131891E8', 77 | 'accountType': {'key': 'DAS', 'text': 'Tagesgeld PLUS-Konto'}, 78 | 'clientId': 'C87A5216C263B8367CAAE2622EB571F9', 79 | 'creditLimit': {'unit': 'EUR', 'value': '0'}, 80 | 'currency': 'EUR', 81 | 'iban': 'DE0820041112345678901'} 82 | """ 83 | 84 | def __init__(self, json): 85 | self.accountDisplayId = json["accountDisplayId"] 86 | self.accountId = json["accountId"] 87 | self.accountType = json["accountType"]["key"] 88 | assert(self.accountType in AccountType) 89 | self.clientId = json["clientId"] 90 | self.creditLimit = AmountValue(json["creditLimit"]) 91 | self.currency = json["currency"] 92 | self.iban = json["iban"] 93 | 94 | def get_accountId(self): 95 | return self.accountId 96 | 97 | def __str__(self): 98 | return f"{AccountType[self.accountType]} ({self.iban})" 99 | 100 | 101 | class AccountBalance(): 102 | """ create from JSON REST response """ 103 | 104 | def __init__(self, json): 105 | if 'account' in json: 106 | self.account = Account(json["account"]) 107 | self.accountId = json["accountId"] 108 | self.availableCashAmount = AmountValue(json["availableCashAmount"]) 109 | self.availableCashAmountEUR = AmountValue(json["availableCashAmountEUR"]) 110 | self.balance = AmountValue(json["balance"]) 111 | self.balanceEUR = AmountValue(json["balanceEUR"]) 112 | assert(self.balanceEUR.unit == "EUR") 113 | assert(self.availableCashAmountEUR.unit == "EUR") 114 | 115 | def __str__(self): 116 | return str(self.balance) 117 | 118 | 119 | class AccountTransaction(): 120 | """ create from JSON REST response 121 | 122 | Example input will look like the following: 123 | {'amount': {'unit': 'EUR', 'value': '-12.34'}, 124 | 'bookingDate': '2020-01-01', 125 | 'bookingStatus': 'BOOKED', 126 | 'creditor': None, 127 | 'deptor': None, 128 | 'directDebitCreditorId': None, 129 | 'directDebitMandateId': None, 130 | 'endToEndReference': None, 131 | 'newTransaction': True, 132 | 'reference': '50C12345A1234567/12345', 133 | 'remittanceInfo': '01Globus TS Forchheim//Forchheim/DE ' 134 | '022020-01-01T20:07:16 KFN 0 VJ 1234', 135 | 'remitter': {'holderName': 'Globus Handelshof'}, 136 | 'transactionType': {'key': 'DIRECT_DEBIT', 'text': 'Direct Debit'}, 137 | 'valutaDate': '2020-01-03'}, 138 | 139 | """ 140 | 141 | def __init__(self, json): 142 | self.amount = AmountValue(json["amount"]) 143 | self.bookingDate = DateString(json["bookingDate"]) if json["bookingDate"] else None 144 | self.bookingStatus = json["bookingStatus"] 145 | assert(self.bookingStatus in ["BOOKED", "NOTBOOKED"]) 146 | self.booked = (self.bookingStatus == "BOOKED") 147 | self.creditor = json["creditor"] 148 | self.deptor = json["deptor"] 149 | self.directDebitCreditorId = json["directDebitCreditorId"] 150 | self.directDebitMandateId = json["directDebitMandateId"] 151 | self.endToEndReference = json["endToEndReference"] 152 | self.newTransaction = json["newTransaction"] 153 | self.reference = json["reference"] 154 | self.remittanceInfo = json["remittanceInfo"] 155 | self.remitter = json["remitter"] 156 | self.transactionType = json["transactionType"]["key"] 157 | # TODO: This will break if you have other transaction types. 158 | # The problem is that comdirect didn't document the keys. 159 | # Please report, if you learn what keys there are! 160 | print(self.transactionType) 161 | # Tolerate unknown transaction types by mapping them to "Unknown" 162 | if self.transactionType not in TransactionType: 163 | TransactionType[self.transactionType] = "Unknown" 164 | assert(self.transactionType in TransactionType) 165 | self.valutaDate = json["valutaDate"] # can be an invalid date! 166 | 167 | def __str__(self): 168 | return f"{self.bookingDate} {self.amount} {self.transactionType}" 169 | 170 | 171 | # --------------------------- DEPOT ---------------------------------------- 172 | 173 | 174 | class Depot(): 175 | def __init__(self, json): 176 | # Some fields may be absent depending on API version 177 | self.depotId = json.get("depotId") 178 | self.depotDisplayId = json.get("depotDisplayId") 179 | self.clientId = json.get("clientId") 180 | self.depotType = json.get("depotType") 181 | self.defaultSettlementAccountId = json.get("defaultSettlementAccountId") 182 | self.settlementAccountIds = json.get("settlementAccountIds") 183 | self.holderName = json.get("holderName") 184 | 185 | def __str__(self): 186 | return str(self.depotId) 187 | 188 | 189 | class DepotBalance(): 190 | def __init__(self, json): 191 | self.depot = Depot(json.get('depot', {})) 192 | self.prevDayValue = json.get("prevDayValue", {}).get("value") 193 | self.currentValue = json.get("currentValue", {}).get("value") 194 | self.purchaseValue = json.get("purchaseValue", {}).get("value") 195 | self.profitSincePurchase = json.get("profitLossPurchaseAbs", {}).get("value") 196 | 197 | self.profitLossPurchaseRel = json.get("profitLossPurchaseRel") 198 | self.profitLossPrevDayRel = json.get("profitLossPrevDayRel") 199 | 200 | def __str__(self): 201 | return ( 202 | f'Depot ID: {self.depot.depotId}' 203 | f'\nDepot Holder: {self.depot.holderName}' 204 | f'\nPrevious Day Value: {self.prevDayValue}' 205 | f'\nCurrent Value: {self.currentValue}' 206 | f'\nPurchase Value: {self.purchaseValue}' 207 | f'\nProfit Since Purchase: {self.profitSincePurchase}' 208 | f'\nTotal Performance: {self.profitLossPurchaseRel}' 209 | f'\n1-Day Performance: {self.profitLossPrevDayRel}' 210 | ) 211 | 212 | class DepotPosition(): 213 | def __init__(self, json): 214 | self.wkn = json.get("wkn") 215 | self.qty = json.get("quantity", {}).get("value", 0) 216 | self.purchaseValue = json.get("purchaseValue", {}).get("value", 0) 217 | self.currentValue = json.get("currentValue", {}).get("value", 0) 218 | self.profitLossPurchaseAbs = json.get("profitLossPurchaseAbs", {}).get("value") 219 | self.profitLossPurchaseRel = json.get("profitLossPurchaseRel", 0) 220 | self.profitLossPrevDayAbs = json.get("profitLossPrevDayAbs", {}).get("value") 221 | self.profitLossPrevDayRel = json.get("profitLossPrevDayRel", 0) 222 | 223 | def __str__(self): 224 | return ( 225 | f'WKN: {self.wkn}' 226 | f'\nQuantity: {self.qty}' 227 | f'\nPurchase Value: {self.purchaseValue}' 228 | f'\nCurrent Value: {self.currentValue}' 229 | f'\nProfit/Loss (Absolute): {self.profitLossPurchaseAbs}' 230 | f'\nProfit/Loss (Relative): {self.profitLossPurchaseRel}' 231 | f'\n1-Day Profit/Loss (Absolute): {self.profitLossPrevDayAbs}' 232 | f'\n1-Day Profit/Loss (Relative): {self.profitLossPrevDayRel}' 233 | ) 234 | 235 | # --------------------------- DOCUMENT ---------------------------------------- 236 | 237 | 238 | class DocumentMetadata(): 239 | """ create from JSON REST response 240 | 241 | Example input will look like the following: 242 | {'alreadyRead': True, 'archived': True, 'dateRead': '2001-12-31', 'predocumentExists': False}, 243 | """ 244 | 245 | def __init__(self, json): 246 | # print(json) 247 | self.alreadyRead = json["alreadyRead"] 248 | if self.alreadyRead: 249 | self.dateRead = DateString(json["dateRead"]) 250 | self.archived = json["archived"] 251 | self.predocumentExists = json["predocumentExists"] 252 | 253 | 254 | class Document(): 255 | """ create from JSON REST response 256 | 257 | Example input will look like the following: 258 | {'advertisement': False, 259 | 'dateCreation': '2001-12-31', 260 | 'deletable': False, 261 | 'documentId': '148B8582CFB8F2C0CB8D3E56131891E8', 262 | 'documentMetaData': {'alreadyRead': True, 'archived': True, 'dateRead': '2001-12-31', 'predocumentExists': False}, 263 | 'mimeType': 'text/html', 264 | 'name': 'Wertpapier-Basisinformationen bei Depoteröffnung'} 265 | """ 266 | 267 | def __init__(self, json): 268 | # print(json) 269 | self.advertisment = json["advertisement"] 270 | self.dateCreation = DateString(json["dateCreation"]) 271 | self.deletable = json["deletable"] 272 | self.documentId = json["documentId"] 273 | self.documentMetadata = DocumentMetadata(json["documentMetaData"]) 274 | self.mimeType = json["mimeType"] 275 | self.name = json["name"] 276 | 277 | def get_filename(self): 278 | fileEnding = ".txt" 279 | if self.mimeType == "text/html": 280 | fileEnding = ".html" 281 | elif self.mimeType == "application/pdf": 282 | fileEnding = ".pdf" 283 | return str(self.dateCreation) + "_" + comdirect_api.utils.make_printable(self.name) + fileEnding 284 | -------------------------------------------------------------------------------- /comdirect_api/session.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import uuid 3 | import base64 4 | import json 5 | import time 6 | import threading 7 | 8 | import comdirect_api.types 9 | from comdirect_api.utils import default_callback_p_tan, \ 10 | default_callback_m_tan,\ 11 | default_callback_p_tan_push,\ 12 | timestamp 13 | 14 | 15 | class Session: 16 | def __init__( 17 | self, 18 | username, 19 | password, 20 | client_id, 21 | client_secret, 22 | callback_p_tan=default_callback_p_tan, 23 | callback_m_tan=default_callback_m_tan, 24 | callback_p_tan_push=default_callback_p_tan_push, 25 | autorefresh=False, 26 | ): 27 | self.autorefresh = autorefresh 28 | 29 | # POST /oauth/token 30 | response = requests.post( 31 | "https://api.comdirect.de/oauth/token", 32 | f"client_id={client_id}&" 33 | f"client_secret={client_secret}&" 34 | f"username={username}&" 35 | f"password={password}&" 36 | f"grant_type=password", 37 | allow_redirects=False, 38 | headers={ 39 | "Accept": "application/json", 40 | "Content-Type": "application/x-www-form-urlencoded", 41 | }, 42 | ) 43 | if not response.status_code == 200: 44 | raise RuntimeError( 45 | f"POST https://api.comdirect.de/oauth/token returned status {response.status_code}" 46 | ) 47 | tmp = response.json() 48 | self.access_token = tmp["access_token"] 49 | self.refresh_token = tmp["refresh_token"] 50 | 51 | # GET /session/clients/user/v1/sessions 52 | self.session_id = uuid.uuid4() 53 | response = requests.get( 54 | "https://api.comdirect.de/api/session/clients/user/v1/sessions", 55 | allow_redirects=False, 56 | headers={ 57 | "Accept": "application/json", 58 | "Authorization": f"Bearer {self.access_token}", 59 | "x-http-request-info": f'{{"clientRequestId":{{"sessionId":"{self.session_id}",' 60 | f'"requestId":"{timestamp()}"}}}}', 61 | }, 62 | ) 63 | if not response.status_code == 200: 64 | raise RuntimeError( 65 | f"GET https://api.comdirect.de/api/session/clients/user/v1/sessions" 66 | f"returned status {response.status_code}" 67 | ) 68 | tmp = response.json() 69 | self.session_id = tmp[0]["identifier"] 70 | 71 | # POST /session/clients/user/v1/sessions/{sessionId}/validate 72 | response = requests.post( 73 | f"https://api.comdirect.de/api/session/clients/user/v1/sessions/{self.session_id}/validate", 74 | allow_redirects=False, 75 | headers={ 76 | "Accept": "application/json", 77 | "Authorization": f"Bearer {self.access_token}", 78 | "x-http-request-info": f'{{"clientRequestId":{{"sessionId":"{self.session_id}",' 79 | f'"requestId":"{timestamp()}"}}}}', 80 | "Content-Type": "application/json", 81 | }, 82 | data=f'{{"identifier":"{self.session_id}","sessionTanActive":true,"activated2FA":true}}', 83 | ) 84 | if response.status_code != 201: 85 | raise RuntimeError( 86 | f"POST /session/clients/user/v1/sessions/.../validate returned status code {response.status_code}" 87 | ) 88 | tmp = json.loads(response.headers["x-once-authentication-info"]) 89 | challenge_id = tmp["id"] 90 | typ = tmp["typ"] 91 | if typ == "P_TAN": 92 | challenge = tmp["challenge"] 93 | if callback_p_tan: 94 | tan = callback_p_tan(base64.b64decode(challenge)) 95 | else: 96 | # TODO: we could retry with other TAN type... 97 | raise RuntimeError( 98 | "cannot handle photo tan because you did not provide handler" 99 | ) 100 | elif typ == "M_TAN": 101 | challenge = tmp["challenge"] 102 | if callback_m_tan: 103 | tan = callback_m_tan() 104 | else: 105 | # TODO: we could retry with other TAN type... 106 | raise RuntimeError( 107 | "cannot handle SMS tan because you did not provide handler" 108 | ) 109 | elif typ == "P_TAN_PUSH": 110 | # challenge is not available for push-tan,wait for confirmation 111 | if callback_p_tan_push: 112 | tan = callback_p_tan_push() 113 | else: 114 | # TODO: we could retry with other TAN type... 115 | raise RuntimeError( 116 | "cannot handle SMS tan because you did not provide handler" 117 | ) 118 | else: 119 | raise RuntimeError(f"unknown TAN type {typ}") 120 | 121 | # PATCH /session/clients/user/v1/sessions/{sessionId} 122 | response = requests.patch( 123 | f"https://api.comdirect.de/api/session/clients/user/v1/sessions/{self.session_id}", 124 | allow_redirects=False, 125 | headers={ 126 | "Accept": "application/json", 127 | "Authorization": f"Bearer {self.access_token}", 128 | "x-http-request-info": f'{{"clientRequestId":{{"sessionId":"{self.session_id}",' 129 | f'"requestId":"{timestamp()}"}}}}', 130 | "Content-Type": "application/json", 131 | "x-once-authentication-info": f'{{"id":"{challenge_id}"}}', 132 | "x-once-authentication": tan, 133 | }, 134 | data=f'{{"identifier":"{self.session_id}","sessionTanActive":true,"activated2FA":true}}', 135 | ) 136 | tmp = response.json() 137 | if not response.status_code == 200: 138 | raise RuntimeError( 139 | f"PATCH https://api.comdirect.de/session/clients/user/v1/sessions/...:" 140 | f"returned status {response.status_code}" 141 | ) 142 | self.session_id = tmp["identifier"] 143 | 144 | # POST https://api.comdirect.de/oauth/token 145 | response = requests.post( 146 | "https://api.comdirect.de/oauth/token", 147 | allow_redirects=False, 148 | headers={ 149 | "Accept": "application/json", 150 | "Content-Type": "application/x-www-form-urlencoded", 151 | }, 152 | data=f"client_id={client_id}&client_secret={client_secret}&" 153 | f"grant_type=cd_secondary&token={self.access_token}", 154 | ) 155 | if not response.status_code == 200: 156 | raise RuntimeError( 157 | f"POST https://api.comdirect.de/oauth/token returned status {response.status_code}" 158 | ) 159 | tmp = response.json() 160 | self.access_token = tmp["access_token"] 161 | self.refresh_token = tmp["refresh_token"] 162 | self.kdnr = tmp["kdnr"] # Kundennummer / number of customer 163 | self.bpid = tmp["bpid"] # no clue what this is 164 | self.kontakt_id = tmp["kontaktId"] # no clue what this is 165 | self.isRevoked = False 166 | 167 | if self.autorefresh: 168 | self.refreshThread = threading.Thread(target=self._refresh_worker) 169 | self.refreshThread.start() 170 | 171 | def _refresh_worker(self): 172 | while not self.isRevoked: 173 | time.sleep(9 * 60) 174 | if self.isRevoked: 175 | break 176 | else: 177 | self.refresh() 178 | 179 | def revoke(self): 180 | if not self.isRevoked: 181 | # DELETE https://api.comdirect.de/oauth/revoke 182 | response = requests.delete( 183 | "https://api.comdirect.de/oauth/revoke", 184 | allow_redirects=False, 185 | headers={ 186 | "Accept": "application/json", 187 | "Authorization": f"Bearer {self.access_token}", 188 | "Content-Type": "application/x-www-form-urlencoded", 189 | }, 190 | data=f'{{"identifier":"{self.session_id}","sessionTanActive":true,"activated2FA":true}}', 191 | ) 192 | if not response.status_code == 204: 193 | raise RuntimeError( 194 | f"DELETE https://api.comdirect.de/oauth/revoke returned unexpected status {response.status_code}" 195 | ) 196 | self.isRevoked = True 197 | 198 | def refresh(self): 199 | # https://api.comdirect.de/oauth/revoke 200 | response = requests.delete( 201 | "https://api.comdirect.de/oauth/revoke", 202 | allow_redirects=False, 203 | headers={ 204 | "Accept": "application/json", 205 | "Authorization": f"Bearer {self.access_token}", 206 | "Content-Type": "application/x-www-form-urlencoded", 207 | }, 208 | data=f'{{"identifier":"{self.session_id}","sessionTanActive":true,"activated2FA":true}}', 209 | ) 210 | if not response.status_code == 204: 211 | raise RuntimeError( 212 | f"DELETE https://api.comdirect.de/oauth/revoke returned unexpected status {response.status_code}" 213 | ) 214 | self.isRevoked = True 215 | 216 | def _get_authorized(self, url, extraheaders={}): 217 | headers = { 218 | "Accept": "application/json", 219 | "Authorization": f"Bearer {self.access_token}", 220 | "x-http-request-info": f'{{"clientRequestId":{{"sessionId":"{self.session_id}",' 221 | f'"requestId":"{timestamp()}"}}}}', 222 | } 223 | headers.update(extraheaders) 224 | response = requests.get(url, allow_redirects=False, headers=headers) 225 | if response.status_code != 200: 226 | raise RuntimeError(f"{url} returned HTTP status {response.status_code}") 227 | return response 228 | 229 | # ------------------------------ ACCOUNT ---------------------------------- 230 | # GET /banking/clients/user/v1/accounts/balances 231 | def account_get_balances(self, paging_first=0, paging_count=1000): 232 | response = self._get_authorized( 233 | f"https://api.comdirect.de/api/banking/clients/user/v1/accounts/balances" 234 | f"?paging-first={paging_first}&paging-count={paging_count}") 235 | return [comdirect_api.types.AccountBalance(i) for i in response.json()["values"]] 236 | 237 | # GET /banking/v2/accounts/{accountid}/balances 238 | def account_get_balance(self, accountid): 239 | response = self._get_authorized(f"https://api.comdirect.de/api/banking/v2/accounts/{accountid}/balances") 240 | return comdirect_api.types.AccountBalance(response.json()) 241 | 242 | # GET /banking/v2/accounts/{accountid}/transactions 243 | # TODO: The filters do not yet work. 244 | # see https://community.comdirect.de/t5/Website-Apps/Rest-API-Filter-Parameter/m-p/108710 245 | def account_get_transactions(self, accountid, transactionDirection="CREDIT_AND_DEBIT", 246 | min_bookingdate=None, max_bookingdate=None, transactionState="BOTH"): 247 | parameters = f"transactionDirection={transactionDirection}&transactionState={transactionState}" 248 | if min_bookingdate: 249 | parameters += f"&min-bookingdate={min_bookingdate}" 250 | if max_bookingdate: 251 | parameters += f"&min-bookingdate={max_bookingdate}" 252 | response = self._get_authorized( 253 | f"https://api.comdirect.de/api/banking/v1/accounts/{accountid}/transactions?{parameters}") 254 | return [comdirect_api.types.AccountTransaction(i) for i in response.json()["values"]] 255 | 256 | # --------------------------- DEPOT ---------------------------------------- 257 | 258 | # GET /brokerage/clients/clientId/v3/depots 259 | def account_get_depots(self, paging_first=0, paging_count=1000): 260 | response = self._get_authorized( 261 | f"https://api.comdirect.de/api/brokerage/clients/user/v3/depots" 262 | f"?paging-first={paging_first}&paging-count={paging_count}") 263 | return [comdirect_api.types.Depot(i) for i in response.json()["values"]] 264 | 265 | # GET /brokerage/v3/depots/{depotId}/positions 266 | def account_get_depot_positions(self, depotid): 267 | response = self._get_authorized( 268 | f"https://api.comdirect.de/api/brokerage/v3/depots/{depotid}/positions") 269 | data = response.json() 270 | balance = comdirect_api.types.DepotBalance(data["aggregated"]) 271 | positions = [comdirect_api.types.DepotPosition(i) for i in data["values"]] 272 | return balance, positions 273 | 274 | # ------------------------------ DOCUMENTS -------------------------------- 275 | # GET /messages/clients/user/v2/documents 276 | def documents_list(self, uuid=None, paging_first=0, paging_count=1000): 277 | if uuid is None: 278 | uuid = "user" 279 | response = self._get_authorized( 280 | f"https://api.comdirect.de/api/messages/clients/{uuid}/v2/documents?" 281 | f"paging-first={paging_first}&paging-count={paging_count}") 282 | return [comdirect_api.types.Document(i) for i in response.json()["values"]] 283 | 284 | # GET /messages/v2/documents/{documentId} 285 | def documents_download(self, document): 286 | response = self._get_authorized(f"https://api.comdirect.de/api/messages/v2/documents/{document.documentId}", 287 | extraheaders={"Accept": document.mimeType}) 288 | return response.content 289 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------