├── release_notes.md ├── postcodes_table_headers.xml ├── config.xml ├── create.py ├── README.md ├── database.py ├── sql_queries_to_csv_example.py ├── companies_table_headers.xml ├── tables.py └── LICENSE /release_notes.md: -------------------------------------------------------------------------------- 1 | # v0.1.1 2 | 3 | ## Code 4 | * Simplified code. 5 | * Improved readability. 6 | * Reduced coupling. 7 | * Renamed files to something more meaningful. 8 | 9 | ## config.xml 10 | * Moved references to xml table headers into the config.xml file to reduce coupling. 11 | * Restructured tables section in config.xml to allow easier generic importing of csv files to tables. 12 | 13 | ## README.md 14 | * Updated links. 15 | 16 | -------------------------------------------------------------------------------- /postcodes_table_headers.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | id 6 | INT 7 | 8 | 9 | 10 | 11 | PostCode 12 | VARCHAR(8) 13 | 14 | 15 | Latitude 16 | VARCHAR(20) 17 | 18 | 19 | Longitude 20 | VARCHAR(20) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /config.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | localhost 7 | 8 | 9 | companies_house 10 | 11 | 12 | 13 | companies_table_headers.xml 14 | False 15 | 16 | 17 | 18 | postcodes_table_headers.xml 19 | True 20 | 21 | 22 | > 23 | -------------------------------------------------------------------------------- /create.py: -------------------------------------------------------------------------------- 1 | import copy 2 | from pathlib import Path 3 | 4 | from database import (database_exists, 5 | create_database, 6 | table_exists, 7 | create_database_connection, 8 | create_database_cursor) 9 | from tables import (config_from_xml_file, 10 | create_mysql_table, 11 | load_data_into_mysql_table) 12 | 13 | 14 | 15 | CONFIG_FILE = str(Path(__file__).parent / 'config.xml') 16 | 17 | 18 | 19 | def main(): 20 | config = config_from_xml_file(CONFIG_FILE) 21 | 22 | mysql_config = copy.deepcopy(config['mysql_config']) 23 | del mysql_config['database'] # databases can't be checked or created if a database is specified 24 | database_connection = create_database_connection(mysql_config) 25 | database_cursor = create_database_cursor(database_connection) 26 | 27 | if database_exists(config, database_cursor): 28 | print("'{}' database already exists.".format(config['database_name'])) 29 | else: 30 | create_database(config, database_cursor) 31 | print() 32 | 33 | database_cursor.stop_cursor() 34 | database_connection.disconnect() 35 | 36 | database_connection = create_database_connection(config['mysql_config']) 37 | database_cursor = create_database_cursor(database_connection) 38 | 39 | for table in config['tables'].keys(): 40 | if table_exists(table, database_cursor): 41 | print("'{}' table already exists.".format(table)) 42 | else: 43 | create_mysql_table(config, table, database_connection, database_cursor) 44 | print("'{}' table has been created.".format(table)) 45 | print("Populating '{}' table with data......".format(table)) 46 | load_data_into_mysql_table(config, table, database_connection, database_cursor) 47 | print("Population of '{}' table has been completed".format(table)) 48 | print() 49 | 50 | database_cursor.stop_cursor() 51 | database_connection.disconnect() 52 | 53 | 54 | 55 | if __name__ == '__main__': 56 | main() 57 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Companies House Data To MySQL Database 2 | 3 | Python 3 code to create a MySQL database comprising UK company data. Two sources of data are imported to the database: 4 | 1. Free UK Companies House data from https://www.gov.uk/government/organisations/companies-house 5 | 2. Free post code vs GPS data from https://www.freemaptools.com 6 | 7 | ## Why 8 | * Searches are very limited using the https://find-and-update.company-information.service.gov.uk/ site, e.g. you can't 9 | currently search by things like outward postcodes, SIC codes, etc. 10 | * The Companies House data doesn't contain any GPS data making it difficult to search by things like distance from a point. 11 | * Importing the data above to MySQL gives a starting point for addressing the issues above and allows much greater flexibility 12 | with querying the data. 13 | 14 | ## Requirements 15 | 1. MySQL (https://dev.mysql.com/downloads/installer/) 16 | 2. Python 3 (https://www.python.org/downloads/) 17 | 3. Python mysql-connector-python module (https://dev.mysql.com/doc/connector-python/en/connector-python-installation-binary.html) 18 | 4. Basic knowledge of these packages. 19 | 20 | ## Instructions 21 | 1. Clone or download this git repository. 22 | 2. Download both of the data files and unzip them: 23 | * http://download.companieshouse.gov.uk/en_output.html (select the 'BasicCompanyDataAsOneFile-\.zip' file) 24 | * https://data.freemaptools.com/download/full-uk-postcodes/ukpostcodes.zip 25 | 3. In the repository config.xml file: 26 | * If required, change the name of the database to be created (by default it is 'companies_house'): To change the name change the text between the \ tags in the parent \ section. 27 | * Add your MySQL username, password and host to the tags between the parent \ tags 28 | * Add the full path and filename for your unzipped 'BasicCompanyDataAsOneFile-\.csv between the \ tags in the parent \ section 29 | * Add the full path and filename for your unzipped 'ukpostcodes.csv between the \ tags in the parent \ section 30 | 4. Run the repository create.py file. This will create the database and tables if they don't already exist. These will then be populated with the Companies House and FreeMapTools data. Its a lot of data so this can take a long time, e.g. an hour or more. 31 | 5. Use Python/MySQL to query the data as required: sql_queries_to_csv_example.py gives an example of querying the data and saving the results to csv files. 32 | -------------------------------------------------------------------------------- /database.py: -------------------------------------------------------------------------------- 1 | import mysql.connector 2 | from mysql.connector import errorcode 3 | 4 | 5 | 6 | class MysqlConnection(): 7 | def __init__(self, config): 8 | self.config = config 9 | self.connection = None 10 | self.connected = False 11 | 12 | 13 | def __str__(self): 14 | attributes = [] 15 | for key in self.__dict__: 16 | attributes.append("{key}='{value}'".format(key=key, value=self.__dict__[key])) 17 | return ', '.join(attributes) 18 | 19 | 20 | def connect(self): 21 | try: 22 | conn = mysql.connector.connect(**self.config) 23 | 24 | except mysql.connector.Error as err: 25 | if err.errno == errorcode.ER_ACCESS_DENIED_ERROR: 26 | print("Your user name or password is incorrect") 27 | elif err.errno == errorcode.ER_BAD_DB_ERROR: 28 | print("The requested database does not exist") 29 | else: 30 | print(err) 31 | self.connection = None 32 | self.connected = False 33 | 34 | else: 35 | self.connection = conn 36 | self.connected = True 37 | 38 | 39 | def disconnect(self): 40 | self.connection.close() 41 | self.connection = None 42 | self.connected = False 43 | 44 | 45 | class MysqlCursor(): 46 | def __init__(self, mysql_connection): 47 | self.connection = mysql_connection 48 | self.cursor = None 49 | self.activecursor = False 50 | 51 | 52 | def __str__(self): 53 | attributes = [] 54 | for key in self.__dict__: 55 | attributes.append("{key}='{value}'".format(key=key, value=self.__dict__[key])) 56 | return ', '.join(attributes) 57 | 58 | 59 | def start_cursor(self): 60 | if isinstance(self.connection.connection, 61 | mysql.connector.connection_cext.CMySQLConnection): 62 | if self.connection.connection.is_connected(): 63 | self.cursor = self.connection.connection.cursor() 64 | self.activecursor = True 65 | else: 66 | print('No connection was present, a cursor could not be created') 67 | 68 | 69 | def stop_cursor(self): 70 | self.cursor.close() 71 | self.cursor = None 72 | self.activecursor = False 73 | 74 | 75 | def execute(self, query): 76 | self.cursor.execute(query) 77 | 78 | 79 | 80 | def list_from_sql_query(database_cursor, query): 81 | database_cursor.execute(query) 82 | mysql_list = [x[0] for x in database_cursor.cursor.fetchall()] 83 | return mysql_list 84 | 85 | 86 | def database_exists(config, database_cursor): 87 | database_name = config['database_name'] 88 | 89 | query = 'show databases' 90 | 91 | return database_name in list_from_sql_query(database_cursor, query) 92 | 93 | 94 | def table_exists(table_name, database_cursor): 95 | query = 'show tables' 96 | return table_name in list_from_sql_query(database_cursor, query) 97 | 98 | 99 | def create_database_connection(mysql_config): 100 | connection = MysqlConnection(mysql_config) 101 | connection.connect() 102 | return connection 103 | 104 | 105 | def create_database_cursor(database_connection): 106 | cursor = MysqlCursor(database_connection) 107 | cursor.start_cursor() 108 | return cursor 109 | 110 | 111 | def create_database(config, database_cursor): 112 | query = 'CREATE DATABASE ' + config['database_name'] 113 | 114 | try: 115 | database_cursor.execute(query) 116 | except mysql.connector.errors.DatabaseError as error: 117 | print('Database: \'' + config['database_name'] + '\' could not be created.') 118 | print(error) 119 | return 120 | else: 121 | print('Database: \'' + config['database_name'] + '\' has been created.') 122 | return 123 | -------------------------------------------------------------------------------- /sql_queries_to_csv_example.py: -------------------------------------------------------------------------------- 1 | import csv 2 | from pathlib import Path 3 | 4 | import database 5 | import tables 6 | import create 7 | 8 | 9 | 10 | COMPANIES_HOUSE_TABLE = 'companies' 11 | SIC_CODE_ENTRIES_PER_DATABASE_RECORD = 4 12 | OUTPUT_FILE_PATH = Path(__name__).parent 13 | 14 | 15 | 16 | def sql_query_to_csv(config, query, database_cursor, csv_output_file): 17 | '''process an SQL query and save the results as a csv file''' 18 | database_cursor.execute(query) 19 | database_records = database_cursor.cursor.fetchall() 20 | 21 | company_table_headers = config['tables'][COMPANIES_HOUSE_TABLE]['headers_xml'] 22 | headers = tables.headers_from_xml_file(company_table_headers) 23 | headers = [header[0] for header in headers] 24 | 25 | with open((csv_output_file), 'wt', newline='', encoding='Latin-1') as output_file: 26 | csv_writer = csv.writer(output_file) 27 | 28 | csv_writer.writerow(headers) 29 | 30 | for database_record in database_records: 31 | csv_writer.writerow(database_record) 32 | 33 | 34 | def create_sql_like_from_sic_codes(sic_code_list): 35 | '''create mysql 'like' string for supplied sic code list''' 36 | output_string = [] 37 | for sic_code in sic_code_list: 38 | sic_string = [] 39 | for i in range(1, SIC_CODE_ENTRIES_PER_DATABASE_RECORD + 1): 40 | string_to_append = ''.join(['SICCode_SicText_', str(i), ' LIKE \'', sic_code, '%\'']) 41 | sic_string.append(string_to_append) 42 | 43 | sic_string = ' OR '.join(sic_string) 44 | 45 | output_string.append(sic_string) 46 | 47 | output_string = ''.join(['(', ' OR '.join(output_string), ')']) 48 | 49 | return output_string 50 | 51 | 52 | def create_sql_like_from_incomplete_postcode(postcode_list): 53 | '''create mysql 'like' string for supplied postcode list''' 54 | output_string = [] 55 | for postcode in postcode_list: 56 | output_string.append(''.join(['RegAddress_PostCode LIKE \'', postcode, '%\''])) 57 | 58 | output_string = ''.join(['(', ' OR '.join(output_string), ')']) 59 | 60 | return output_string 61 | 62 | 63 | def query_001(config, database_cursor): 64 | '''Postcodes within 3 miles of LE16, active companies, specified SICs''' 65 | filename = '3Miles_Active.csv' 66 | postcode_list = ['LE16', 'LE17', 'LE8', 'LE94', 'NN14', 'NN6'] 67 | sic_list = ['58290', '62011', '62012', '62020', '62090', '63110', '63990'] 68 | 69 | query = ('SELECT * FROM companies ' + 70 | 'WHERE ' + 71 | 'Accounts_AccountCategory <> \'DORMANT\' AND ' + 72 | create_sql_like_from_incomplete_postcode(postcode_list) + ' AND ' + 73 | 'CompanyStatus = \'Active\' AND ' + 74 | create_sql_like_from_sic_codes(sic_list)) 75 | 76 | output_file = str(OUTPUT_FILE_PATH / filename) 77 | 78 | sql_query_to_csv(config, query, database_cursor, output_file) 79 | 80 | 81 | def query_002(config, database_cursor): 82 | '''Postcodes within 20 miles of LE16, active companies, specified SICs''' 83 | filename = '20Miles_Active.csv' 84 | postcode_list = ['CV11', 'CV12', 'CV2', 'CV21', 'CV22', 'CV23', 'CV7', 'CV8', 85 | 'LE1', 'LE10', 'LE12', 'LE13', 'LE14', 'LE15', 'LE16', 'LE17', 86 | 'LE18', 'LE19', 'LE2', 'LE21', 'LE3', 'LE4', 'LE41', 'LE5', 87 | 'LE55', 'LE6', 'LE67', 'LE7', 'LE8', 'LE87', 'LE9', 'LE94', 88 | 'LE95', 'NN1', 'NN10', 'NN11', 'NN12', 'NN14', 'NN15', 'NN16', 89 | 'NN17', 'NN18', 'NN2', 'NN29', 'NN3', 'NN4', 'NN5', 'NN6', 90 | 'NN7', 'NN8', 'NN9', 'NN99', 'PE8', 'PE9'] 91 | sic_list = ['62012', '62020'] 92 | query = ('SELECT * FROM companies ' + 93 | 'WHERE ' + 94 | 'Accounts_AccountCategory <> \'DORMANT\' AND ' + 95 | create_sql_like_from_incomplete_postcode(postcode_list) + ' AND ' + 96 | 'CompanyStatus = \'Active\' AND ' + 97 | create_sql_like_from_sic_codes(sic_list)) 98 | 99 | output_file = str(OUTPUT_FILE_PATH / filename) 100 | 101 | sql_query_to_csv(config, query, database_cursor, output_file) 102 | 103 | 104 | def main(): 105 | '''entry point of the code''' 106 | config = tables.config_from_xml_file(create.CONFIG_FILE) 107 | 108 | database_connection = database.create_database_connection(config['mysql_config']) 109 | database_cursor = database.create_database_cursor(database_connection) 110 | 111 | query_001(config, database_cursor) 112 | query_002(config, database_cursor) 113 | 114 | 115 | 116 | if __name__ == '__main__': 117 | main() 118 | -------------------------------------------------------------------------------- /companies_table_headers.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | id 6 | INT 7 | 8 | 9 | 10 | 11 | CompanyName 12 | VARCHAR(160) 13 | 14 | 15 | CompanyNumber 16 | VARCHAR(8) 17 | 18 | 19 | RegAddress_CareOf 20 | VARCHAR(100) 21 | 22 | 23 | RegAddress_POBox 24 | VARCHAR(10) 25 | 26 | 27 | RegAddress_AddressLine1 28 | VARCHAR(300) 29 | 30 | 31 | RegAddress_AddressLine2 32 | VARCHAR(300) 33 | 34 | 35 | RegAddress_PostTown 36 | VARCHAR(50) 37 | 38 | 39 | RegAddress_County 40 | VARCHAR(50) 41 | 42 | 43 | RegAddress_Country 44 | VARCHAR(50) 45 | 46 | 47 | RegAddress_PostCode 48 | VARCHAR(20) 49 | 50 | 51 | CompanyCategory 52 | VARCHAR(100) 53 | 54 | 55 | CompanyStatus 56 | VARCHAR(70) 57 | 58 | 59 | CountryofOrigin 60 | VARCHAR(50) 61 | 62 | 63 | DissolutionDate 64 | VARCHAR(10) 65 | 66 | 67 | IncorporationDate 68 | VARCHAR(10) 69 | 70 | 71 | Accounts_AccountRefDay 72 | VARCHAR(2) 73 | 74 | 75 | Accounts_AccountRefMonth 76 | VARCHAR(2) 77 | 78 | 79 | Accounts_NextDueDate 80 | VARCHAR(10) 81 | 82 | 83 | Accounts_LastMadeUpDate 84 | VARCHAR(10) 85 | 86 | 87 | Accounts_AccountCategory 88 | VARCHAR(30) 89 | 90 | 91 | Returns_NextDueDate 92 | VARCHAR(10) 93 | 94 | 95 | Returns_LastMadeUpDate 96 | VARCHAR(10) 97 | 98 | 99 | Mortgages_NumMortCharges 100 | VARCHAR(6) 101 | 102 | 103 | Mortgages_NumMortOutstanding 104 | VARCHAR(6) 105 | 106 | 107 | Mortgages_NumMortPartSatisfied 108 | VARCHAR(6) 109 | 110 | 111 | Mortgages_NumMortSatisfied 112 | VARCHAR(6) 113 | 114 | 115 | SICCode_SicText_1 116 | VARCHAR(170) 117 | 118 | 119 | SICCode_SicText_2 120 | VARCHAR(170) 121 | 122 | 123 | SICCode_SicText_3 124 | VARCHAR(170) 125 | 126 | 127 | SICCode_SicText_4 128 | VARCHAR(170) 129 | 130 | 131 | LimitedPartnerships_NumGenPartners 132 | VARCHAR(6) 133 | 134 | 135 | LimitedPartnerships_NumLimPartners 136 | VARCHAR(6) 137 | 138 | 139 | URI 140 | VARCHAR(47) 141 | 142 | 143 | PreviousName_1_CONDATE 144 | VARCHAR(10) 145 | 146 | 147 | PreviousName_1_CompanyName 148 | VARCHAR(160) 149 | 150 | 151 | PreviousName_2_CONDATE 152 | VARCHAR(10) 153 | 154 | 155 | PreviousName_2_CompanyName 156 | VARCHAR(160) 157 | 158 | 159 | PreviousName_3_CONDATE 160 | VARCHAR(10) 161 | 162 | 163 | PreviousName_3_CompanyName 164 | VARCHAR(160) 165 | 166 | 167 | PreviousName_4_CONDATE 168 | VARCHAR(10) 169 | 170 | 171 | PreviousName_4_CompanyName 172 | VARCHAR(160) 173 | 174 | 175 | PreviousName_5_CONDATE 176 | VARCHAR(10) 177 | 178 | 179 | PreviousName_5_CompanyName 180 | VARCHAR(160) 181 | 182 | 183 | PreviousName_6_CONDATE 184 | VARCHAR(10) 185 | 186 | 187 | PreviousName_6_CompanyName 188 | VARCHAR(160) 189 | 190 | 191 | PreviousName_7_CONDATE 192 | VARCHAR(10) 193 | 194 | 195 | PreviousName_7_CompanyName 196 | VARCHAR(160) 197 | 198 | 199 | PreviousName_8_CONDATE 200 | VARCHAR(10) 201 | 202 | 203 | PreviousName_8_CompanyName 204 | VARCHAR(160) 205 | 206 | 207 | PreviousName_9_CONDATE 208 | VARCHAR(10) 209 | 210 | 211 | PreviousName_9_CompanyName 212 | VARCHAR(160) 213 | 214 | 215 | PreviousName_10_CONDATE 216 | VARCHAR(10) 217 | 218 | 219 | PreviousName_10_CompanyName 220 | VARCHAR(160) 221 | 222 | 223 | ConfStmtNextDueDate 224 | VARCHAR(10) 225 | 226 | 227 | ConfStmtLastMadeUpDate 228 | VARCHAR(10) 229 | 230 | 231 | 232 | -------------------------------------------------------------------------------- /tables.py: -------------------------------------------------------------------------------- 1 | import csv 2 | from datetime import datetime 3 | import xml.etree.ElementTree as ET 4 | 5 | 6 | 7 | PROGRESS_STEP_ROWS = 100000 8 | 9 | 10 | 11 | def double_braces_string(no_of_instances): 12 | return '{} {}, ' * no_of_instances 13 | 14 | 15 | def single_braces_string(no_of_instances): 16 | return ('{}, ' * (no_of_instances - 1)) + '{}' 17 | 18 | 19 | def single_braces_quotes_string(no_of_instances): 20 | return ('\"{}\", ' * (no_of_instances - 1)) + '\"{}\"' 21 | 22 | 23 | def mysql_table_creation_string(table_name, headers): 24 | curly_braces_for_non_id_headers = double_braces_string(len(headers) - 1) 25 | 26 | sql_create_table_format = ''.join(['CREATE TABLE {} ', 27 | '({} {} AUTO_INCREMENT, ', 28 | curly_braces_for_non_id_headers, 29 | 'PRIMARY KEY ({}))']) 30 | 31 | sql_create_table_values = [table_name] 32 | sql_create_table_values += [item for sublist in headers for item in sublist] 33 | sql_create_table_values += [headers[0][0]] 34 | 35 | table_creation_string = sql_create_table_format.format(*sql_create_table_values) 36 | 37 | return table_creation_string 38 | 39 | 40 | def mysql_insert_record_format_string(headers): 41 | braces_for_column_names = single_braces_string(len(headers) - 1) 42 | braces_and_quotes_for_values = single_braces_quotes_string(len(headers) - 1) 43 | 44 | sql_insert_str_format = ''.join(['INSERT INTO {} (', 45 | braces_for_column_names, 46 | ') VALUES (', 47 | braces_and_quotes_for_values, 48 | ')']) 49 | return sql_insert_str_format 50 | 51 | 52 | def make_strings_mysql_compatible(list_of_strings): 53 | 54 | for i in range(len(list_of_strings)): 55 | # the line directly below must come before the other replacements to avoid their 56 | # resultant escape characters being erroneously replaced 57 | list_of_strings[i] = list_of_strings[i].replace('\\', '\\\\') 58 | 59 | list_of_strings[i] = list_of_strings[i].replace('\'', '\\\'') 60 | list_of_strings[i] = list_of_strings[i].replace('"', '\\\"') 61 | list_of_strings[i] = list_of_strings[i].replace('%', '\\%') 62 | list_of_strings[i] = list_of_strings[i].replace('_', '\\_') 63 | 64 | return list_of_strings 65 | 66 | 67 | def config_from_xml_file(config_file): 68 | config_tree = ET.parse(config_file) 69 | config_root = config_tree.getroot() 70 | 71 | config = {} 72 | config['mysql_user'] = config_root.find('MySQL').find('user').text 73 | config['mysql_password'] = config_root.find('MySQL').find('password').text 74 | config['mysql_host'] = config_root.find('MySQL').find('host').text 75 | config['database_name'] = config_root.find('Database').find('name').text 76 | 77 | config['tables'] = {} 78 | tables = config_root.find('Database').find('Tables') 79 | for table in tables: 80 | source_csv = table.find('source_csv').text 81 | headers_xml = table.find('headers_xml').text 82 | 83 | ignore_first_column = table.find('ignore_first_column').text 84 | if ignore_first_column.lower() == 'true': 85 | ignore_first_column = True 86 | elif ignore_first_column.lower() == 'false': 87 | ignore_first_column = False 88 | else: 89 | ignore_first_column = False 90 | 91 | table_tag = table.tag 92 | config['tables'][table_tag] = {'source_csv': source_csv, 93 | 'headers_xml': headers_xml, 94 | 'ignore_first_column': ignore_first_column} 95 | 96 | config['mysql_config'] = {'user': config['mysql_user'], 97 | 'database': config['database_name'], 98 | 'password': config['mysql_password'], 99 | 'host': config['mysql_host']} 100 | 101 | return config 102 | 103 | 104 | def headers_from_xml_file(xml_file): 105 | xml_tree = ET.parse(xml_file) 106 | xml_root = xml_tree.getroot() 107 | 108 | id_header_name = xml_root.find('idfield').find('field').find('name').text 109 | id_header_type = xml_root.find('idfield').find('field').find('type').text 110 | 111 | headers = [[id_header_name, id_header_type]] 112 | 113 | non_id_headers = xml_root.find('other_fields').findall('field') 114 | 115 | for non_id_header in non_id_headers: 116 | header_name = non_id_header.find('name').text 117 | header_type = non_id_header.find('type').text 118 | 119 | headers.append([header_name, header_type]) 120 | 121 | return headers 122 | 123 | 124 | def create_mysql_table(config, table_name, database_connection, database_cursor): 125 | xml_file = config['tables'][table_name]['headers_xml'] 126 | headers = headers_from_xml_file(xml_file) 127 | 128 | table_creation_string = mysql_table_creation_string(table_name, headers) 129 | 130 | database_cursor.execute(table_creation_string) 131 | database_connection.connection.commit() 132 | 133 | 134 | def load_data_into_mysql_table(config, table_name, database_connection, database_cursor): 135 | filename = config['tables'][table_name]['source_csv'] 136 | ignore_first_column = config['tables'][table_name]['ignore_first_column'] 137 | 138 | xml_file = config['tables'][table_name]['headers_xml'] 139 | headers = headers_from_xml_file(xml_file) 140 | 141 | sql_insert_str_format = mysql_insert_record_format_string(headers) 142 | 143 | sql_input_str_first_values = [table_name] 144 | sql_input_str_first_values += [sublist[0] for sublist in headers][1:] 145 | 146 | print(''.join(['Starting: ', datetime.now().strftime('%Y-%m-%d %H:%M:%S')])) 147 | with open(filename, encoding="Latin-1") as data_file: 148 | csv_reader = csv.reader(data_file) 149 | line_count = 0 150 | for row in csv_reader: 151 | if line_count > 0: 152 | mutable_row = row 153 | 154 | if ignore_first_column: 155 | mutable_row = mutable_row[1:] 156 | 157 | mysql_compatible_values = make_strings_mysql_compatible(mutable_row) 158 | 159 | mysql_insert_string = sql_insert_str_format.format( 160 | *sql_input_str_first_values + mysql_compatible_values) 161 | database_cursor.execute(mysql_insert_string) 162 | 163 | if (line_count % PROGRESS_STEP_ROWS) == 0: 164 | database_connection.connection.commit() 165 | print(''.join(['{:,}'.format(line_count), 166 | ' records added to the database @ ', 167 | datetime.now().strftime('%Y-%m-%d %H:%M:%S')])) 168 | 169 | line_count += 1 170 | 171 | database_connection.connection.commit() 172 | print(''.join(['Finished: ', datetime.now().strftime('%Y-%m-%d %H:%M:%S')])) 173 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------