├── requirements.txt ├── Dockerfile ├── .env_sample ├── .gitignore ├── README.md ├── main.py ├── scraping └── scraping_functions.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ChiffX/gpu-stock-scraper/HEAD/requirements.txt -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | #https://github.com/joyzoursky/docker-python-chromedriver 2 | FROM joyzoursky/python-chromedriver 3 | WORKDIR /usr/workspace 4 | COPY . . 5 | RUN pip install -r requirements.txt 6 | ENTRYPOINT [ "python", "/usr/workspace/main.py" ] 7 | -------------------------------------------------------------------------------- /.env_sample: -------------------------------------------------------------------------------- 1 | EMAIL = youremail@gmail.com 2 | PASSWORD = youremailpassword 3 | RECIPIENT1 = recipient1@gmail.com 4 | RECIPIENT2 = recipient2@gmail.com 5 | DISCORD_WEBHOOK = follow this page for instructions: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | docker_env 108 | env/ 109 | venv/ 110 | ENV/ 111 | env.bak/ 112 | venv.bak/ 113 | 114 | # Spyder project settings 115 | .spyderproject 116 | .spyproject 117 | 118 | # Rope project settings 119 | .ropeproject 120 | 121 | # mkdocs documentation 122 | /site 123 | 124 | # mypy 125 | .mypy_cache/ 126 | .dmypy.json 127 | dmypy.json 128 | 129 | # Pyre type checker 130 | .pyre/ 131 | chromedriver 132 | .vscode/settings.json 133 | chromedriver.exe 134 | desktop.ini 135 | main_reddit.py 136 | scraping/scraping_functions_reddit.py 137 | main_beep_only.py 138 | scraping/scraping_functions_beep_only.py 139 | 140 | main_mitch.py 141 | scraping/scraping_functions_mitch.py 142 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GPU Stock Scraper 2 | 3 | [![PyPI](https://img.shields.io/badge/Python-3.9-green.svg)]() 4 | 5 | GPU Stock Scraper is a script to scrape various Canadian computer part supplier websites 6 | and determine if stock exists for a given item. 7 | 8 | #### Data Source Websites #### 9 | 10 | At the time of this script, RTX 3080 are being scanned across: 11 | * Newegg.ca 12 | * Checks online stock 13 | * Bestbuy.ca 14 | * Differentiates online vs backorder vs nearby-store stock 15 | * Memoryexpress.com 16 | * Differentiates online vs in-store stock 17 | * Allows selection of specific stores 18 | * Canadacomputers.com 19 | * Differentiates online vs in-store stock 20 | * Allows selection of specific stores 21 | * Amazon.ca 22 | * Checks online stock 23 | * PC-canada.com 24 | * Checks online stock 25 | 26 | ## Usage 27 | 28 | ### Requirements 29 | 1. Download appropriate [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) to the `scraping/` folder 30 | 2. `pip3 install -r requirements.txt` 31 | 32 | ### Enabling Gmail 33 | * **NOTE**: This method is fairly insecure and Google will ask you to allow insecure apps to use this method 34 | 1. Go to the [Less secure app access section of your Google Account](https://myaccount.google.com/lesssecureapps). You might need to sign in. 35 | 2. Turn Allow less secure apps on. 36 | 3. Create a .env file, using .env_sample as a guide, and input email information 37 | 38 | ### Enabling Discord Messages 39 | 1. Acquire your webhook URL from your Discord server for your selected channel 40 | * See here for an explanation: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks 41 | 2. Assign your webhook URL to DISCORD_WEBHOOK in your .env file 42 | 3. Set discord_message_enabled to True 43 | 44 | ### Operation 45 | `python3 main.py` 46 | 47 | ### Docker Usage 48 | The docker image contains the chromedriver and python3, if you already have docker, you're good to go. 49 | 1. Build the image: `docker build -t gpu-stock-scraper .` 50 | 2. Run the image: `docker run --rm -t gpu-stock-scraper` 51 | 3. If you'd like email, set these environment variables `docker run -e EMAIL=${EMAIL} -e PASSWORD=${PASSWORD} -e RECIPIENT1=${RECIPIENT1} -e RECIPIENT2=${RECIPIENT2} --rm -t gpu-stock-scraper` 52 | 4. If you'd like to change the base interval frequency, add the INTERVAL environment variable `docker run -e INTERVAL=60 --rm -t gpu-stock-scraper` 53 | 54 | ### Optional customization 55 | 1. Modify stores_to_check in scrape_canada_computers() and scrape_memory_express() to reflect your local stores 56 | 2. If you are receiving an error installing dotenv, try "pip3 install python-dotenv" 57 | 58 | 59 | ## Project Next Steps 60 | * Build a config file 61 | * Decouple email, discord, and beep functions from the scraping_functions.py file into their own 62 | * Add model-specific filtering (meanwhile, filter via website then update URL) 63 | * Refine search_best_buy() to only return matches for select stores 64 | * Use a more secure method (potentially oauth) for sending emails 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | """Scrapes computer part supplier websites for detecting stock of desired item. 2 | Generates and sends email with link and details to in-stock item when detected. 3 | """ 4 | 5 | import random 6 | import datetime 7 | import time 8 | import os 9 | from scraping.scraping_functions import scrape_vendors, initialize_webdriver 10 | 11 | # Comment/uncomment vendors and change URLs as needed, but keep the same webpage structure for each vendor. 12 | vendors_to_scrape = { 13 | "Newegg": "https://www.newegg.ca/p/pl?d=Rtx+3080&N=50001402%2050001312%2050001315%2050012150%2050001314%20601357282%20100007708&LeftPriceRange=0+1300", 14 | "Best Buy": "https://www.bestbuy.ca/en-ca/collection/rtx-30-series-graphic-cards/316108?path=category%253AComputers%2B%2526%2BTablets%253Bcategory%253APC%2BComponents%253Bcategory%253AGraphics%2BCards%253Bcustom0graphicscardtype%253AGeForce%2BRTX%2B3080", 15 | "Memory Express": "https://www.memoryexpress.com/Category/VideoCards?FilterID=fdd27ae5-da44-3d27-95bc-3076cc5fc8f3", 16 | "Canada Computers": "https://www.canadacomputers.com/index.php?cPath=43_557_559&sf=:3_5&mfr=&pr=", 17 | "Amazon": "https://www.amazon.ca/stores/GeForce/RTX3080_GEFORCERTX30SERIES/page/6B204EA4-AAAC-4776-82B1-D7C3BD9DDC82", 18 | "PC Canada": "https://www.pc-canada.com/p/go/go.asp?CATID=10074&OPTID=111116290%2C1596338%7C%2C111114984%2C19789374", 19 | } 20 | 21 | # Used for email subject line only. URLs in vendors_to_scrape must be updated to actually scrape for it. 22 | item = "RTX 3080" 23 | 24 | def main(): 25 | # Initial email message states. Prevents email spamming later. 26 | email_bodies = { 27 | "Newegg": "", 28 | "Best Buy": "", 29 | "Memory Express": "", 30 | "Canada Computers": "", 31 | "Amazon": "", 32 | "PC Canada": "", 33 | } 34 | 35 | userdefined_interval = os.getenv("INTERVAL") 36 | if userdefined_interval is not None: 37 | print(f"Using user defined interval of {userdefined_interval} (+random 15) seconds .\n") 38 | 39 | while True: 40 | # Timestamp for scan 41 | now = datetime.datetime.now() 42 | print(now.strftime("%Y-%m-%d %H:%M:%S")) 43 | 44 | try: 45 | driver = initialize_webdriver() 46 | # Scrapes all specified vendors 47 | for vendor_name, URL in vendors_to_scrape.items(): 48 | email_body = scrape_vendors(vendor_name, URL, driver, item, email_bodies) 49 | email_bodies[vendor_name] = email_body 50 | driver.close() 51 | except Exception as e: 52 | print("Error: " + str(e)) 53 | 54 | random_interval = random.randrange(15, 30) 55 | if userdefined_interval is None: 56 | # Waits 15 to 30 seconds before attempting next scan 57 | print(f"\nNext scan in {random_interval} seconds.\n") 58 | time.sleep(random_interval) 59 | else: 60 | interval = int(userdefined_interval) + random_interval 61 | print(f"\nNext scan in {interval} seconds.\n") 62 | time.sleep(interval) 63 | random.random() 64 | 65 | 66 | if __name__ == "__main__": 67 | main() 68 | -------------------------------------------------------------------------------- /scraping/scraping_functions.py: -------------------------------------------------------------------------------- 1 | """This module contains the functions necessary to scan computer supplier webpages and send messages 2 | 3 | Functions: 4 | initialize_webdriver() 5 | scrape_vendors() 6 | scrape_newegg() 7 | scrape_bestbuy() 8 | scrape_memoryexpress() 9 | scrape_canada_computers() 10 | scrape_amazon() 11 | scrape_pc_canada() 12 | maybe_send_email() 13 | send_email() 14 | send_discord_message() 15 | title_line() 16 | make_beep_noise() 17 | """ 18 | 19 | from selenium import webdriver 20 | from selenium.webdriver.chrome.options import Options 21 | from email.mime.text import MIMEText 22 | from fake_useragent import UserAgent 23 | import os.path 24 | from os import path 25 | import requests 26 | from discord import Webhook, RequestsWebhookAdapter, Embed 27 | import smtplib 28 | import dotenv 29 | import os 30 | import sys 31 | 32 | # Beep style based on system type 33 | if sys.platform == "win32": 34 | import winsound 35 | elif sys.platform == "linux": 36 | from beepy import beep 37 | 38 | 39 | # Set to True to turn on 40 | discord_message_enabled = True 41 | email_enabled = False 42 | beep_enabled = True 43 | 44 | 45 | def initialize_webdriver(): 46 | """Initializes a chrome webdriver for use in the scraping functions. 47 | Generates a random user agent and run in a headless browser. 48 | Compatible with both Windows and Linux once chromedriver paths are set. 49 | 50 | :return: the initialized webdriver, ready to accept URLs 51 | """ 52 | # Manually set the paths to Windows and/or Linux chromedriver location 53 | # Chrome Drivers found here: https://sites.google.com/a/chromium.org/chromedriver/downloads 54 | WINDOWS_PATH = './chromedriver.exe' 55 | LINUX_PATH = './chromedriver' 56 | DOCKER_PATH = '/usr/local/bin/chromedriver' 57 | 58 | # Operates as a random user agent in a headless browser 59 | chromeOptions = Options() 60 | ua = UserAgent() 61 | userAgent = ua.random 62 | chromeOptions.add_experimental_option('excludeSwitches', ['enable-logging']) 63 | chromeOptions.add_argument(f'user-agent={userAgent}') 64 | chromeOptions.headless = True 65 | 66 | if (path.exists(WINDOWS_PATH)): 67 | driver = webdriver.Chrome(executable_path=WINDOWS_PATH, options=chromeOptions) 68 | elif (path.exists(LINUX_PATH)): 69 | driver = webdriver.Chrome(executable_path=LINUX_PATH, options=chromeOptions) 70 | else: 71 | chromeOptions.add_argument('--no-sandbox') 72 | chromeOptions.add_argument('--headless') 73 | chromeOptions.add_argument('--disable-gpu') 74 | driver = webdriver.Chrome(executable_path=DOCKER_PATH, options=chromeOptions) 75 | 76 | driver.get('chrome://settings/clearBrowserData') 77 | 78 | return driver 79 | 80 | 81 | def scrape_vendors(vendor_name, URL, driver, item, email_bodies): 82 | """Scrapes respective vendor URL to detect any stock for the given item 83 | 84 | :param vendor_name: a given vendor name, specified in main.py 85 | :param URL: a respective URL to scrape, attached to vendor_name 86 | :param driver: an initialized webdriver 87 | :param item: the name of the item to check stock for 88 | :param email_bodies: the email body from the previous email sent, "" if no previous body 89 | :return: email_body if vendor_name is valid 90 | """ 91 | title_line(vendor_name) 92 | 93 | driver.get(URL) 94 | driver.implicitly_wait(10) 95 | 96 | # Scrape all vendors specified in main.py. Sends email if stock is detected. 97 | if vendor_name.lower().strip() == "newegg": 98 | email_body = scrape_newegg(driver, vendor_name) 99 | maybe_send_email(item, email_body, email_bodies, vendor_name) 100 | return email_body 101 | elif vendor_name.lower().strip() == "best buy": 102 | email_body = scrape_bestbuy(driver, vendor_name) 103 | maybe_send_email(item, email_body, email_bodies, vendor_name) 104 | return email_body 105 | elif vendor_name.lower().strip() == "memory express": 106 | email_body = scrape_memory_express(driver, vendor_name) 107 | maybe_send_email(item, email_body, email_bodies, vendor_name) 108 | return email_body 109 | elif vendor_name.lower().strip() == "canada computers": 110 | email_body = scrape_canada_computers(driver, vendor_name) 111 | maybe_send_email(item, email_body, email_bodies, vendor_name) 112 | return email_body 113 | elif vendor_name.lower().strip() == "amazon": 114 | email_body = scrape_amazon(driver, vendor_name) 115 | maybe_send_email(item, email_body, email_bodies, vendor_name) 116 | return email_body 117 | 118 | elif vendor_name.lower().strip() == "pc canada": 119 | email_body = scrape_pc_canada(driver, vendor_name) 120 | maybe_send_email(item, email_body, email_bodies, vendor_name) 121 | return email_body 122 | else: 123 | raise ValueError("Vendor specified does not match existing vendors.") 124 | 125 | 126 | def scrape_newegg(driver, vendor_name): 127 | """Scrapes a single newegg.ca webpage with multiple listings for any in-stock items. 128 | 129 | :param driver: an initialized webdriver 130 | :param vendor_name: the name of the vendor for the respective webpage 131 | :return: email_body 132 | """ 133 | # Check all listings on page for stock 134 | stock_dict = {} 135 | 136 | listings = driver.find_elements_by_class_name("item-cell") 137 | for listing in listings: 138 | item_name = listing.find_element_by_class_name("item-title").text 139 | item_URL = listing.find_element_by_class_name("item-title").get_attribute("href") 140 | price = listing.find_element_by_class_name("price-current").text 141 | stock_status = listing.find_element_by_class_name("item-promo").text 142 | secondary_stock_status = listing.find_element_by_class_name("item-button-area").text 143 | if ("OUT OF STOCK" not in stock_status 144 | and "SOLD OUT" not in stock_status 145 | and "AUTO NOTIFY" not in secondary_stock_status): 146 | stock_dict[item_name] = {} 147 | stock_dict[item_name]["url"] = item_URL 148 | stock_dict[item_name]["price"] = price 149 | print(f"Online stock found: \n{item_URL} for {price}") 150 | stock_dict[item_name]["online stock status"] = "In stock" 151 | stock_dict[item_name]["in store status"] = "Not checked" 152 | stock_dict[item_name]["backorder status"] = "Not checked" 153 | 154 | email_body = generate_email_body(stock_dict, vendor_name) 155 | 156 | return email_body 157 | 158 | 159 | def scrape_bestbuy(driver, vendor_name): 160 | """Scrapes a single bestbuy.ca webpage with multiple listings for any in-stock items. 161 | 162 | :param vendor_name: the name of the webpage vendor 163 | :param driver: an initialized webdriver 164 | :return: the email message body 165 | """ 166 | # Check all listings on page for stock 167 | stock_dict = {} 168 | 169 | listings = driver.find_elements_by_xpath("//a[@itemprop='url']") 170 | for listing in listings: 171 | item_URL = listing.get_attribute("href") 172 | item_name = listing.find_element_by_class_name("productItemName_3IZ3c").text 173 | price = listing.find_element_by_class_name("price_FHDfG").text 174 | if ("Available to ship" in listing.text 175 | or "Available online only" in listing.text 176 | or "Available at nearby stores" in listing.text 177 | or "Available for backorder" in listing.text): 178 | stock_dict[item_name] = {} 179 | stock_dict[item_name]["url"] = item_URL 180 | stock_dict[item_name]["price"] = price 181 | 182 | # Online 183 | if "Available to ship" in listing.text or "Available online only" in listing.text: 184 | print(f"Online stock found: \n{item_URL} for {price}") 185 | stock_dict[item_name]["online stock status"] = "In stock" 186 | else: 187 | stock_dict[item_name]["online stock status"] = "Out of stock" 188 | 189 | # In store 190 | if "Available at nearby stores" in listing.text: 191 | stock_dict[item_name]["in store status"] = "In store" 192 | stock_dict[item_name]["store location"] = "Store location unspecified" 193 | else: 194 | stock_dict[item_name]["in store status"] = "Unavailable in store" 195 | 196 | # Backorder 197 | if "Available for backorder" in listing.text: 198 | print(f"Backorder stock found: \n{item_URL} for {price}") 199 | stock_dict[item_name]["backorder status"] = "Available for backorder" 200 | else: 201 | stock_dict[item_name]["backorder status"] = "Unavailable for backorder" 202 | 203 | email_body = generate_email_body(stock_dict, vendor_name) 204 | 205 | return email_body 206 | 207 | 208 | def scrape_memory_express(driver, vendor_name): 209 | """Scrapes a single memoryexpress.com webpage with multiple listings for any in-stock items. 210 | 211 | :param vendor_name: the name of the webpage vendor 212 | :param driver: an initialized webdriver 213 | :return: email_body 214 | """ 215 | # Add or comment/uncomment desired store location names here, case sensitive 216 | stores_to_check = [ 217 | "Vancouver", 218 | # "Victoria", 219 | "Burnaby", 220 | "Richmond", 221 | ] 222 | 223 | # Check all listings on page for stock 224 | memory_express_urls = [] 225 | 226 | stock_status_elements = driver.find_elements_by_class_name("c-shca-add-product-button") # Contains stock information text 227 | for stock_status in stock_status_elements: 228 | if "Buy this item" in stock_status.get_attribute('title'): 229 | item_URL_element = stock_status.find_element_by_xpath('./../../../div[1]/div[2]/div[2]/a') 230 | item_URL = item_URL_element.get_attribute("href") 231 | memory_express_urls.append(item_URL) 232 | 233 | # Iterates through individual pages for where stock may have been detected 234 | stock_dict = {} 235 | for URL in memory_express_urls: 236 | driver.get(URL) 237 | driver.implicitly_wait(10) 238 | 239 | # Stores item and link details 240 | item_name = driver.title.rstrip("- Memory Express Inc.") 241 | stock_dict[item_name] = {} 242 | stock_dict[item_name]["url"] = URL 243 | 244 | # Checks online stock status before proceeding 245 | stores_inventory = driver.find_elements_by_class_name('c-capr-inventory-store__name') 246 | for store_location in stores_inventory: 247 | if "Online Store" in store_location.text: 248 | store_stock = (store_location.find_element_by_xpath('./../span[2]')).text 249 | if (store_stock != "Out of Stock" 250 | and store_stock != "Backorder" 251 | and int(store_stock.rstrip("+")) > 0): 252 | print(f"Online stock found: \n{URL}") 253 | stock_dict[item_name]["online stock status"] = "In stock" 254 | else: 255 | stock_dict[item_name]["online stock status"] = "Out of stock" 256 | 257 | if len(stores_to_check) != 0: 258 | # Expand the stores availability frame 259 | all_stores_toggle = driver.find_element_by_css_selector(".c-capr-inventory-selector__toggle") 260 | driver.execute_script("arguments[0].setAttribute('class','c-capr-inventory-selector__toggle c-capr-inventory-selector__toggle--opened')", all_stores_toggle) 261 | second_stores_toggle = driver.find_element_by_css_selector(".c-capr-inventory-selector__dropdown-container") 262 | driver.execute_script("arguments[0].setAttribute('class','c-capr-inventory-selector__dropdown-container')", second_stores_toggle) 263 | stores_inventory = driver.find_elements_by_class_name('c-capr-inventory-store__name') 264 | 265 | # Checks and stores local store stock status for item 266 | stock_dict[item_name]["in store status"] = "No store stock" 267 | for store_location in stores_inventory: 268 | store_stock = (store_location.find_element_by_xpath('./../span[2]')).text 269 | if (store_stock != "Out of Stock" 270 | and store_stock != "Backorder" 271 | and int(store_stock.rstrip("+*")) > 0): 272 | store = (store_location.text).rstrip(':') 273 | if store in stores_to_check: 274 | print(f"In-store stock found at {store}: \n{URL}") 275 | stock_dict[item_name]["in store status"] = "In store" 276 | if "store location" in stock_dict[item_name]: 277 | stock_dict[item_name]["store location"] += f", {store}" 278 | else: 279 | stock_dict[item_name]["store location"] = store 280 | else: 281 | stock_dict[item_name]["in store status"] = "Not checked" 282 | 283 | stock_dict[item_name]["backorder status"] = "Not checked" 284 | 285 | email_body = generate_email_body(stock_dict, vendor_name) 286 | 287 | return email_body 288 | 289 | 290 | def scrape_canada_computers(driver, vendor_name): 291 | """Scrapes a single canadacomputers.com webpage with multiple listings for any in-stock items. 292 | 293 | :param vendor_name: the name of the webpage vendor 294 | :param driver: an initialized webdriver 295 | :return: email_body 296 | """ 297 | # Add or comment/uncomment desired store location names here, case sensitive 298 | stores_to_check = [ 299 | # Ontario 300 | "Markham", 301 | "Midtown Toronto", 302 | "Richmond Hill", 303 | "Etobicoke", 304 | "Newmarket", 305 | "North York", 306 | "Vaughan", 307 | "Downtown Toronto", 308 | "Ajax", 309 | "Mississauga", 310 | "Brampton", 311 | "Scarborough", 312 | 313 | # BC 314 | "Vancouver Broadway", 315 | "East Vancouver", 316 | "Burnaby", 317 | "Richmond", 318 | ] 319 | 320 | # Check all listings on page for stock 321 | canada_computer_urls = [] 322 | stock_dict = {} 323 | 324 | listings = driver.find_elements_by_class_name("stocklevel-pop") 325 | for listing in listings: 326 | listing_info = listing.find_element_by_xpath("following-sibling::div[1]") 327 | try: 328 | driver.implicitly_wait(0.01) # Give the scraper 10 ms to look for the element below 329 | item_URL = ((listing_info.find_element_by_class_name("productImageSearch")).find_element_by_tag_name("a")).get_attribute("href") 330 | # pq-hdr-bolder contains stock information text if the item is in stock at all, otherwise does not appear on page 331 | stock_status_element = listing_info.find_elements_by_class_name('pq-hdr-bolder') 332 | if (len(stock_status_element) != 0 333 | and "not available" not in stock_status_element.text.lower() 334 | and "back order" not in stock_status_element.text.lower()): 335 | canada_computer_urls.append(item_URL) 336 | except: # When stock_status_element is not on the page for that listing, move on to the next listing 337 | pass 338 | 339 | 340 | # Iterates through individual pages for where stock may have been detected 341 | for URL in canada_computer_urls: 342 | driver.get(URL) 343 | driver.implicitly_wait(10) 344 | # Looks for items in stock online vs in store 345 | for elements in driver.find_elements_by_class_name('pi-prod-availability'): 346 | item_name = driver.title.rstrip("| Canada Computers & Electronics") 347 | stock_dict[item_name] = {} 348 | stock_dict[item_name]["url"] = URL 349 | # Checks and stores online stock status for item 350 | if "Online In Stock" in elements.text: 351 | print(f"Online stock found: \n{URL}") 352 | stock_dict[item_name]["online stock status"] = "In stock" 353 | else: 354 | stock_dict[item_name]["online stock status"] = "Out of stock" 355 | 356 | # Checks and stores local store stock status for item 357 | if len(stores_to_check) != 0: 358 | if "Available In Stores" in elements.text: 359 | # Opens inventory view for all stores 360 | other_stores = driver.find_element_by_css_selector(".stocklevel-pop") 361 | driver.execute_script("arguments[0].setAttribute('class','stocklevel-pop d-block')", other_stores) 362 | 363 | # Only changes if stock at desired store is detected 364 | stock_dict[item_name]["in store status"] = "No store stock" 365 | 366 | for store in stores_to_check: 367 | # Finds store's name on webpage 368 | store_element = driver.find_element_by_link_text(store) 369 | # Finds stock value by xpath relative to store name 370 | stock = store_element.find_element_by_xpath('./../../../div[2]/div/p/span').text 371 | 372 | # Converts stock value into integer 373 | if stock == "-": 374 | stock = 0 375 | else: 376 | stock = int(stock[0:1]) # Truncates 5+ to 5 377 | 378 | if stock > 0: 379 | print(f"In-store stock found at {store}: \n{URL}") 380 | stock_dict[item_name]["in store status"] = "In store" 381 | if "store location" in stock_dict[item_name]: 382 | stock_dict[item_name]["store location"] += f", {store}" 383 | else: 384 | stock_dict[item_name]["store location"] = store 385 | else: 386 | stock_dict[item_name]["in store status"] = "No store stock" 387 | else: 388 | stock_dict[item_name]["in store status"] = "Not checked" 389 | 390 | stock_dict[item_name]["backorder status"] = "Not checked" 391 | 392 | email_body = generate_email_body(stock_dict, vendor_name) 393 | 394 | return email_body 395 | 396 | 397 | def scrape_amazon(driver, vendor_name): 398 | """Scrapes a single amazon.ca webpage with multiple listings for any in-stock items. 399 | 400 | :param driver: an initialized webdriver 401 | :param vendor_name: the name of the vendor for the respective webpage 402 | :return: email_body 403 | """ 404 | # Check all listings on page for stock 405 | stock_dict = {} 406 | price_limit = 1400 407 | 408 | listings = driver.find_elements_by_class_name("ProductGridItem__itemOuter__5ow0w") 409 | for listing in listings: 410 | item_URL = listing.find_element_by_class_name("ProductGridItem__overlay__1ncmn").get_attribute("href") 411 | item_name = listing.find_element_by_class_name("ProductGridItem__title__2C1kS").text 412 | price_div_element = listing.find_element_by_class_name("ProductGridItem__price__2H_kW") 413 | if price_div_element.text != "": # If out of stock, no price will be shown in this div element 414 | price = float((listing.find_element_by_class_name("style__whole__3EZEk").text).replace(",", "")) # Formats the price to float 415 | # Set price limits here 416 | if price < price_limit: 417 | stock_dict[item_name] = {} 418 | stock_dict[item_name]["url"] = item_URL 419 | stock_dict[item_name]["price"] = price 420 | print(f"Online stock found: \n{item_URL} for {price}") 421 | stock_dict[item_name]["online stock status"] = "In stock" 422 | stock_dict[item_name]["in store status"] = "Not checked" 423 | stock_dict[item_name]["backorder status"] = "Not checked" 424 | 425 | email_body = generate_email_body(stock_dict, vendor_name) 426 | 427 | return email_body 428 | 429 | 430 | def scrape_pc_canada(driver, vendor_name): 431 | """Scrapes a single pc-canada.com webpage with multiple listings for any in-stock items. 432 | 433 | :param vendor_name: the name of the webpage vendor 434 | :param driver: an initialized webdriver 435 | :return: email_body 436 | """ 437 | 438 | # Check all listings on page for stock 439 | stock_dict = {} 440 | 441 | stock_status_elements = driver.find_elements_by_css_selector("p.text-theme-shipping") # Contains stock information text 442 | for stock_status in stock_status_elements: 443 | if "On Backorder" not in stock_status.text and "" != stock_status.text: 444 | item_URL_element = stock_status.find_element_by_xpath('./../../../../div[5]/div[1]/p/a') 445 | item_URL = item_URL_element.get_attribute("href") 446 | item_name = item_URL_element.text 447 | print(item_name) 448 | stock_dict[item_name] = {} 449 | stock_dict[item_name]["url"] = item_URL 450 | print(f"Online stock found: \n{item_URL}") 451 | stock_dict[item_name]["online stock status"] = "In stock" 452 | stock_dict[item_name]["in store status"] = "Not checked" 453 | stock_dict[item_name]["backorder status"] = "Not checked" 454 | 455 | email_body = generate_email_body(stock_dict, vendor_name) 456 | 457 | return email_body 458 | 459 | 460 | def generate_email_body(stock_dict, vendor_name): 461 | """Generates an email body based on passed stock dictionary and vendor 462 | 463 | :param stock_dict: a stock summary dictionary created in the scraping function 464 | :param vendor_name: the name of the vendor that was scraped 465 | """ 466 | # Creates a summary list of items in stock, differentiating online vs in store 467 | stock_summary = [] 468 | for item, details in stock_dict.items(): 469 | if details["online stock status"] == "In stock": 470 | stock_summary.append(f"{item} is in stock ONLINE at {vendor_name} for {details['price']}\n" 471 | f"{details['url']}\n\n") 472 | if details["in store status"] == "In store": 473 | stock_summary.append(f"{item} is in stock IN STORE at {vendor_name} for {details['price']}\n" 474 | f"{details['store location'].upper()}\n" 475 | f"{details['url']}\n\n") 476 | if details["backorder status"] == "Available for backorder": 477 | stock_summary.append(f"{item} is AVAILABLE FOR BACKORDER at {vendor_name} for {details['price']}\n" 478 | f"{details['url']}\n\n") 479 | 480 | # Generates an email message from the summary list 481 | email_body = "" 482 | for hits in stock_summary: 483 | email_body += hits 484 | 485 | return email_body 486 | 487 | 488 | def maybe_send_email(item, email_body, email_bodies, vendor_name): 489 | """Sends an email if the email body is not blank and is not the same as the previous email body 490 | Prevents spamming emails. Optionally sends a discord message too. 491 | 492 | :param item: the name of the item being checked for 493 | :param email_body: a string containing in-stock items 494 | :param email_bodies: the email body from the previous email sent, "" if no previous body 495 | :param vendor_name: the vendor name 496 | :return: none 497 | """ 498 | # Only sends if the email body does not start the same as the last email sent 499 | if email_body != "" and email_body[:20] not in email_bodies[vendor_name]: 500 | print("Stock detected. Sending selected message types.") 501 | 502 | # Comes up with the subject line based on availability type 503 | if "online" in email_body.lower() and "in store" in email_body.lower(): 504 | subject = f"{item} in Stock ONLINE and IN STORE at {vendor_name}" 505 | elif "online" in email_body.lower(): 506 | subject = f"{item} in Stock ONLINE at {vendor_name}" 507 | elif "in store" in email_body.lower(): 508 | subject = f"{item} in Stock IN STORE at {vendor_name}" 509 | elif "backorder" in email_body.lower(): 510 | subject = f"{item} available for BACKORDER at {vendor_name}" 511 | 512 | # Sends different notification types 513 | if beep_enabled: 514 | make_beep_noise() 515 | if discord_message_enabled: 516 | try: 517 | send_discord_message(subject, email_body) 518 | except: 519 | print("Error with sending discord message.") 520 | if send_email: 521 | send_email(subject, email_body) 522 | 523 | elif email_body != "": 524 | print("Previous email items still in stock.") 525 | else: 526 | print("No stock found") 527 | 528 | 529 | def send_email(subject, email_body): 530 | """Sends an email containing the in-stock item details and link to the desired recipients 531 | 532 | :param subject: a string containing the in-stock status type and which website 533 | :param email_body: a string containing in-stock model details and website link 534 | :return: none 535 | """ 536 | # Load sensitive login data from local .env file 537 | dotenv.load_dotenv() 538 | GMAIL_LOGIN = os.getenv('EMAIL') 539 | GMAIL_PASSWORD = os.getenv('PASSWORD') 540 | RECIPIENTS = [] 541 | if os.getenv("RECIPIENT1") is not None: 542 | RECIPIENTS.append(os.getenv("RECIPIENT1")) 543 | if os.getenv("RECIPIENT2") is not None: 544 | RECIPIENTS.append(os.getenv("RECIPIENT2")) 545 | 546 | to_addr = RECIPIENTS 547 | from_addr = GMAIL_LOGIN 548 | 549 | msg = MIMEText(email_body) 550 | msg['Subject'] = subject 551 | 552 | server = smtplib.SMTP('smtp.gmail.com', 587) 553 | server.ehlo() 554 | server.starttls() 555 | server.ehlo() 556 | server.login(GMAIL_LOGIN, GMAIL_PASSWORD) 557 | server.sendmail(from_addr, to_addr, msg.as_string()) 558 | server.close() 559 | 560 | 561 | def title_line(vendor_name): 562 | """Prints the vendor name surrounded by "---" for readability in terminal""" 563 | vendor_name = vendor_name + " " 564 | while len(vendor_name) < 30: 565 | vendor_name += "-" 566 | print(vendor_name) 567 | 568 | 569 | def send_discord_message(subject, email_body): 570 | """Sends an embedded message to your specific discord channel 571 | 572 | :param subject: the subject line of an email message 573 | :param email_body: the email body of an email message 574 | """ 575 | dotenv.load_dotenv() 576 | webhook_url = os.getenv('DISCORD_WEBHOOK') 577 | webhook = Webhook.from_url(webhook_url, adapter=RequestsWebhookAdapter()) 578 | embed = Embed(title=subject, description=email_body) 579 | webhook.send(embed=embed, tts=True) 580 | 581 | 582 | def make_beep_noise(): 583 | """Makes an audible beep sound. Supports Windows and Linux.""" 584 | if beep_enabled: 585 | if sys.platform == "win32": 586 | duration = 1000 587 | freq = 1000 588 | winsound.Beep(freq, duration) 589 | elif sys.platform == "linux": 590 | # Documentation here: https://docs.python.org/3/library/sys.html#sys.platform 591 | beep(sound=1) 592 | else: 593 | print("Platform not supported for make_beep_noise().") -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------