├── Procfile ├── _config.yml ├── static ├── images │ ├── nvidia.png │ └── nvidia_RTX.png ├── backgrounds │ ├── bg-404.jpeg │ └── bg-main.jpeg ├── CSVs │ ├── nvidia_RTX.csv │ └── nvidia.csv └── style.css ├── requirements.txt ├── templates ├── index.html ├── show_wc.html ├── review.html ├── 404.html └── base.html ├── README.md ├── .gitignore ├── app.py └── LICENSE /Procfile: -------------------------------------------------------------------------------- 1 | web: gunicorn app:app 2 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-hacker -------------------------------------------------------------------------------- /static/images/nvidia.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/c17hawke/flask-based-wordcloud-generator/HEAD/static/images/nvidia.png -------------------------------------------------------------------------------- /static/images/nvidia_RTX.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/c17hawke/flask-based-wordcloud-generator/HEAD/static/images/nvidia_RTX.png -------------------------------------------------------------------------------- /static/backgrounds/bg-404.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/c17hawke/flask-based-wordcloud-generator/HEAD/static/backgrounds/bg-404.jpeg -------------------------------------------------------------------------------- /static/backgrounds/bg-main.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/c17hawke/flask-based-wordcloud-generator/HEAD/static/backgrounds/bg-main.jpeg -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | beautifulsoup4==4.8.1 2 | bs4==0.0.1 3 | certifi==2019.11.28 4 | chardet==3.0.4 5 | Click==7.0 6 | decorator==4.4.1 7 | entrypoints==0.3 8 | Flask==1.1.1 9 | Flask-Cors==3.0.9 10 | gunicorn==20.0.4 11 | idna==2.8 12 | itsdangerous==1.1.0 13 | jinja2>=2.11.3 14 | jsonschema==3.2.0 15 | MarkupSafe==1.1.1 16 | matplotlib==3.1.3 17 | mccabe==0.6.1 18 | numpy==1.18.1 19 | pandas==1.0.1 20 | python-dateutil==2.8.1 21 | pytz==2019.3 22 | pyzmq==18.1.1 23 | requests==2.22.0 24 | six==1.14.0 25 | soupsieve==1.9.5 26 | urllib3==1.25.8 27 | webencodings==0.5.1 28 | Werkzeug==1.0.0 29 | widgetsnbextension==3.5.1 30 | wordcloud==1.6.0 31 | pyOpenSSL==20.0.1 32 | -------------------------------------------------------------------------------- /templates/index.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block title %} 4 | 5 | c17hawke 6 | 7 | {% endblock title%} 8 | 9 | {% block body %} 10 | 11 | 12 |
13 | 21 |
22 | 23 | 24 | 25 | {% endblock body %} -------------------------------------------------------------------------------- /templates/show_wc.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block title %} 4 | Wordcloud 5 | {% endblock title %} 6 | 7 | {% block searchbar %} 8 |
9 | 10 | 11 |
12 | {% endblock searchbar %} 13 | 14 | {% block body %} 15 | 19 |
20 |
21 | ... 22 |
Wordcloud
23 |
24 |
25 | 35 | 36 | {% endblock body %} -------------------------------------------------------------------------------- /templates/review.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block title %} 4 | 5 | Reviews 6 | 7 | {% endblock title %} 8 | 9 | 10 | {% block word_cloud %} 11 | 14 | 17 | {% endblock word_cloud %} 18 | 19 | 20 | {% block searchbar %} 21 | 22 |
23 | 25 | 26 |
27 | 28 | {% endblock searchbar %} 29 | 30 | 31 | {% block body %} 32 |
33 | {% for table in tables %} 34 |

{{ table | safe }}

35 | {% endfor %} 36 | 37 |
38 | {% endblock body %} -------------------------------------------------------------------------------- /static/CSVs/nvidia_RTX.csv: -------------------------------------------------------------------------------- 1 | Product,Name,Price (INR),Rating,Comment Heading,Comment 2 | Dell Inspiron 7000 Core i7 9th Gen - (16 GB/512 GB SSD/Windows 10 Home/6 GB Graphics/NVIDIA Geforce RTX 2060) INS 7590 Gaming Laptop,Sachin Ramesh Vyas ,139990.0,5,Must buy!,Good laptop with nice build and configuration go for it 3 | Dell KB 216 Wired USB Desktop Keyboard,GIRISH JETTY,574.0,5,Terrific,"Thme most simplest and slimmest DELL ever keyboard for all rounding purpose (GAMING, OFFICE, STUDENT)" 4 | Dell KB 216 Wired USB Desktop Keyboard,Aravindraj.G,574.0,5,Good Product,Good Product 5 | Dell KB 216 Wired USB Desktop Keyboard,Sushanta Dutta,574.0,5,Classy product,VERY NICE PRODUCT 6 | Dell KB 216 Wired USB Desktop Keyboard,PRIYESH KANERIA,574.0,5,NICE PRODICT,NICE PRODICT 7 | Dell KB 216 Wired USB Desktop Keyboard,Amit Maurya,574.0,5,Awesome,very nice keyboard 8 | Dell KB 216 Wired USB Desktop Keyboard,Shiva Kumar,574.0,5,Highly recommended,The product was awesome and i reiceved it before the expected delivery date and the keys are very soft and over all the product was awesome 9 | Dell KB 216 Wired USB Desktop Keyboard,ABHISHEK GHOSH,574.0,5,Great product,Value for money. Highly recommended. 10 | Dell KB 216 Wired USB Desktop Keyboard,Karan Kumar,574.0,5,Wonderful,Keys Very Soft.. Good to work Great Product 11 | Dell KB 216 Wired USB Desktop Keyboard,Jitendra Kumar Muduli,574.0,5,Terrific purchase,amezing products with smooth keys... go for it 12 | Dell KB 216 Wired USB Desktop Keyboard,Flipkart Customer,574.0,5,Classy product,Very good product using it for almost 1yr but still i don't see any issues 13 | Dell KB 216 Wired USB Desktop Keyboard,No Name,574.0,No Rating,No Comment Heading, 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Flask based wordcloud generator 2 | This is a flask based app to scrap user reviews and comments from a retail website and generates word-cloud with CSV data. 3 | The data that was gathered is available to download as well. 4 | 5 | This could be a way to showcase a buyer that what in general other consumers are feeling about that product. 6 | 7 | **For live demo you can check here-** http://c17hawke-scraper01.herokuapp.com/ 8 | 9 | ## Following is some screenshots from the project - 10 | ### 1. Home page with a search bar to search a product. 11 | 12 | ![Home page](https://github.com/c17hawke/peronal-blog-2020/blob/master/project_screenshots/flask-based-wordcloud-generator/homePage.png?raw=true) 13 | --- 14 | ### 2. Page to display the reviews in a tablular form. From here you can download the data as well. 15 | 16 | ![Results page](https://github.com/c17hawke/peronal-blog-2020/blob/master/project_screenshots/flask-based-wordcloud-generator/search_results.png?raw=true) 17 | --- 18 | ### 3. To see the wordcloud generated you can click on wordcloud tab in the navbar that will open a new page with wordcloud generated with buyer's comment. This gives a brief idea about the product. 19 | 20 | ![Wordcloud display](https://github.com/c17hawke/peronal-blog-2020/blob/master/project_screenshots/flask-based-wordcloud-generator/wordcloud.png?raw=true) 21 | --- 22 | ### 4. 404 page will be seen if you enter something gibrish or product is not spelled properly. 23 | 24 | ![404 error page](https://github.com/c17hawke/peronal-blog-2020/blob/master/project_screenshots/flask-based-wordcloud-generator/404.png?raw=true) 25 | 26 | ### 5. View on my cellphone - 27 | 28 | ![view on phone](https://github.com/c17hawke/peronal-blog-2020/blob/master/project_screenshots/flask-based-wordcloud-generator/view_on_phone.jpg?raw=true) 29 | -------------------------------------------------------------------------------- /templates/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Page not found 8 | 9 | 10 | 11 |
12 |
13 |
14 |
15 |

Oops!

16 |

404 Not Found

17 |
18 | Sorry, an error has occured, Requested page not found! 19 |
20 | 24 |
25 |
26 |
27 |
28 | 29 | 30 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /templates/base.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 12 | 13 | {% block title %} 14 | {% endblock title %} 15 | 16 | 17 | 18 | 19 | 20 | 39 | 40 | 41 | {% block body %} 42 | {% endblock body %} 43 | 44 | 45 | 46 | 47 | 48 | 49 | 52 | 55 | 58 | 59 | 60 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | .vscode/ -------------------------------------------------------------------------------- /static/CSVs/nvidia.csv: -------------------------------------------------------------------------------- 1 | Product,Name,Price (INR),Rating,Comment Heading,Comment 2 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,RAAZ MALHOTRA,3450.0,1,Absolute rubbish!,Ordered GDDR5 received GDDR3 😡No Replacement They are providing Refund 3 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Flipkart Customer,3450.0,4,Pretty good,working great playing all games at 30-60 fps 4 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Atif Albasar,3450.0,4,Wonderful,Running games at good 30-40 fps 5 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Chandrakant Patil,3450.0,5,Mind-blowing purchase,superb card you can play gta 5 on full settings easily 👌👌👌 6 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Flipkart Customer,3450.0,1,Utterly Disappointed,Not good No return remember 7 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Pranav warke,3450.0,5,Great product,good..product..mala tar khup awdla pan khup lightwight ahe..saglya game run hotat 8 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Flipkart Customer,3450.0,5,Terrific purchase,nice 9 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,Alangir Mondal,3450.0,5,Brilliant,good product 10 | Gigabyte NVIDIA GT 710 2 GB GDDR5 Graphics Card,No Name,3450.0,No Rating,No Comment Heading, 11 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,Swapnil Joshi,6000.0,5,Classy product,"Awesome Product, Great Performance , Nvidia has been always been a best in the businessThanks to flipkart and Nvidia" 12 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,Surya,6000.0,5,Classy product,nice 13 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,Varun Singh Rana,6000.0,5,Great product,medium graphic card but best for dual core and i3 processors 14 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,KUSHRAM VINOD,6000.0,5,Terrific purchase,Graphic card is gud and system is working fine with high graphic games 15 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,Seena S,6000.0,4,Good quality product,good product 16 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,Battu Asha,6000.0,2,Slightly disappointed,worst 17 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,Mukhtar Ahmed,6000.0,3,Fair,It is too large I an not install in my PC . Showing no return policy whil I was purching it is not reflected on my order 18 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,rama chandran,6000.0,5,Great product,Super 19 | GALAX NVIDIA GEFORCE GT 730 4GB DDR3 4 GB GDDR3 Graphics Card,No Name,6000.0,No Rating,No Comment Heading, 20 | Electrobot i3-9100F (8 GB RAM/1 TB Hard Disk/120 GB SSD Capacity/Free DOS/4 GB Graphics Memory) Mid Tower,Flipkart Customer,41999.0,5,Super!,First of all I'm very happy because I got a windows 10 Home installed and all the drivers are also installed I was not expecting this because it's written free dos. . Okay I got what it's written except smps 400w but it's a very good brand (xigmatex) . 400w I think it's enough for this specs. GPU- GALAX .. RAM- G SKILLS.. MSI motherboard. And lastly they give me wifi us adapter.. Thank you All. 21 | Electrobot i3-9100F (8 GB RAM/1 TB Hard Disk/120 GB SSD Capacity/Free DOS/4 GB Graphics Memory) Mid Tower,Saunak Jana,41999.0,5,Best in the market!,"I think i am very lucky to get this BEAST in rs 31,999. I searched many places for this combination and only this one had it in that budget. So far performance has been like a hot knife on butter. Just after my purchase the price hiked to rs 39,999." 22 | Electrobot i3-9100F (8 GB RAM/1 TB Hard Disk/120 GB SSD Capacity/Free DOS/4 GB Graphics Memory) Mid Tower,Flipkart Customer,41999.0,5,Highly recommended,Budget king 23 | -------------------------------------------------------------------------------- /static/style.css: -------------------------------------------------------------------------------- 1 | 2 | *{ 3 | font-family: "Lucida Sans Unicode", "Lucida Grande", sans-serif; 4 | font-size: large; 5 | } 6 | 7 | body { 8 | font-size: large; 9 | 10 | text-align: center; 11 | background-image: url("/static/backgrounds/bg-main.jpeg"); 12 | padding-top: 4%; 13 | background-attachment: fixed; 14 | background-position: center; 15 | background-repeat: no-repeat; 16 | background-size: cover; 17 | } 18 | 19 | /* 1st index page */ 20 | #legend{ 21 | color: white; 22 | } 23 | 24 | 25 | .search-box-div{ 26 | background-color: black; 27 | padding: 10% 7% 10% 7%; 28 | margin-top: 20%; 29 | margin-left: 20%; 30 | margin-right: 20%; 31 | opacity: 70%; 32 | border-radius: 20px; 33 | } 34 | 35 | .copyright{ 36 | color: white; 37 | /* padding-top: 5%; */ 38 | opacity: 50%; 39 | } 40 | 41 | .button{ 42 | margin-top: 5%; 43 | } 44 | .copyright{ 45 | padding-top: 10%; 46 | opacity: 50%; 47 | } 48 | 49 | /* 2nd review page */ 50 | a, h1, h3 { 51 | color: white; 52 | } 53 | h1, h3 { margin: 0; 54 | } 55 | h1 { border-bottom: 2px solid #eee; } 56 | h3 { font-size: 1.2em; } 57 | 58 | table.dataframe, .dataframe th, .dataframe td { 59 | border: none; 60 | border-bottom: 1px solid #C8C8C8; 61 | border-collapse: collapse; 62 | text-align:center; 63 | padding: 10px; 64 | margin-bottom: 40px; 65 | font-size: 0.9em; 66 | opacity: 90%; 67 | } 68 | 69 | .data th { 70 | background-color: black; 71 | color: white; 72 | } 73 | 74 | 75 | tr:nth-child(odd) { background-color:#393e46; } 76 | tr:nth-child(even) { background-color:#222831; } 77 | 78 | tr:hover { background-color: #29a19c; color: black;} 79 | 80 | 81 | /* virat's CSS */ 82 | 83 | @media screen and (max-width: 700px) { 84 | 85 | body{ 86 | padding-top: 25%; 87 | } 88 | table, tr, td { 89 | padding-top: 10%; 90 | display: block; 91 | } 92 | 93 | td:first-child { 94 | position: absolute; 95 | top: 50%; 96 | -webkit-transform: translateY(-50%); 97 | transform: translateY(-50%); 98 | width: 100px; 99 | } 100 | td:not(:first-child) { 101 | clear: both; 102 | margin-left: 100px; 103 | padding: 4px 20px 4px 90px; 104 | position: relative; 105 | text-align: left; 106 | } 107 | td:not(:first-child):before { 108 | color: #91ced4; 109 | content: ''; 110 | display: block; 111 | left: 0; 112 | position: absolute; 113 | } 114 | 115 | td:nth-child(2):before { 116 | content: 'Product:'; 117 | } 118 | td:nth-child(3):before { 119 | content: 'Name:'; 120 | } 121 | td:nth-child(4):before { 122 | content: 'Price (INR):'; 123 | } 124 | td:nth-child(5):before { 125 | content: 'Rating:'; 126 | } 127 | td:nth-child(6):before { 128 | content: 'Heading:'; 129 | } 130 | td:nth-child(7):before { 131 | content: 'Comment:'; 132 | } 133 | 134 | /* */ 135 | tr { 136 | padding: 10px 0; 137 | position: relative; 138 | } 139 | tr:first-child { 140 | display: none; 141 | } 142 | /* } */ 143 | /* @media screen and (max-width: 500px) { */ 144 | .header { 145 | background-color: transparent; 146 | color: white; 147 | font-size: 2em; 148 | font-weight: 700; 149 | padding: 0; 150 | text-shadow: 2px 2px 0 rgba(0, 0, 0, 0.1); 151 | } 152 | 153 | img { 154 | border: 3px solid; 155 | border-color: #daeff1; 156 | height: 100px; 157 | margin: 0.5rem 0; 158 | width: 100px; 159 | } 160 | 161 | td:first-child { 162 | /* background-color: #c8e7ea; 163 | border-bottom: 1px solid #91ced4; */ 164 | border-radius: 10px 10px 0 0; 165 | position: relative; 166 | top: 0; 167 | -webkit-transform: translateY(0); 168 | transform: translateY(0); 169 | width: 100%; 170 | } 171 | td:not(:first-child) { 172 | margin: 0; 173 | padding: 5px 1em; 174 | width: 100%; 175 | } 176 | td:not(:first-child):before { 177 | font-size: .8em; 178 | padding-top: 0.3em; 179 | position: relative; 180 | } 181 | td:last-child { 182 | padding-bottom: 1rem !important; 183 | } 184 | 185 | tr { 186 | /* background-color: white !important; 187 | border: 1px solid #6cbec6; */ 188 | border-radius: 10px; 189 | box-shadow: 2px 2px 0 rgba(0, 0, 0, 0.1); 190 | margin: 0.5rem 0; 191 | padding: 0; 192 | } 193 | 194 | .table-users { 195 | border: none; 196 | box-shadow: none; 197 | overflow: visible; 198 | } 199 | } -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | ''' 2 | # Author: Sunny Bhaveen Chandra 3 | # Contact: sunny.c17hawke@gmail.com 4 | # dated: March, 04, 2020 5 | ''' 6 | # import necessary libraries 7 | from bs4 import BeautifulSoup as soup 8 | import urllib 9 | import requests 10 | import pandas as pd 11 | import time 12 | import os 13 | from flask import Flask, render_template, session, redirect, request 14 | from flask_cors import CORS,cross_origin 15 | import matplotlib.pyplot as plt 16 | from wordcloud import WordCloud, STOPWORDS 17 | import ssl 18 | 19 | # define global paths for Image and csv folders 20 | IMG_FOLDER = os.path.join('static', 'images') 21 | CSV_FOLDER = os.path.join('static', 'CSVs') 22 | 23 | app = Flask(__name__) 24 | cors = CORS(app, resources={r"/api/*": {"origins": "*"}}) 25 | # config environment variables 26 | app.config['IMG_FOLDER'] = IMG_FOLDER 27 | app.config['CSV_FOLDER'] = CSV_FOLDER 28 | 29 | # ssl certificate verification 30 | try: 31 | _create_unverified_https_context = ssl._create_unverified_context 32 | except AttributeError: 33 | # Legacy Python that doesn't verify HTTPS certificates by default 34 | pass 35 | else: 36 | # Handle target environment that doesn't support HTTPS verification 37 | ssl._create_default_https_context = _create_unverified_https_context 38 | 39 | class DataCollection: 40 | ''' 41 | class meant for collection and management of data 42 | ''' 43 | def __init__(self): 44 | # dictionary to gather data 45 | self.data = {"Product": list(), 46 | "Name": list(), 47 | "Price (INR)": list(), 48 | "Rating": list(), 49 | "Comment Heading": list(), 50 | "Comment": list()} 51 | 52 | def get_final_data(self, commentbox=None, prodName=None, prod_price=None): 53 | ''' 54 | this will append data gathered from comment box into data dictionary 55 | ''' 56 | # append product name 57 | self.data["Product"].append(prodName) 58 | self.data["Price (INR)"].append(prod_price) 59 | try: 60 | # append Name of customer if exists else append default 61 | self.data["Name"].append(commentbox.div.div.\ 62 | find_all('p', {'class': '_2sc7ZR _2V5EHH'})[0].text) 63 | except: 64 | self.data["Name"].append('No Name') 65 | 66 | try: 67 | # append Rating by customer if exists else append default 68 | self.data["Rating"].append(commentbox.div.div.div.div.text) 69 | except: 70 | self.data["Rating"].append('No Rating') 71 | 72 | try: 73 | # append Heading of comment by customer if exists else append default 74 | self.data["Comment Heading"].append(commentbox.div.div.div.p.text) 75 | except: 76 | self.data["Comment Heading"].append('No Comment Heading') 77 | 78 | try: 79 | # append comments of customer if exists else append default 80 | comtag = commentbox.div.div.find_all('div', {'class': ''}) 81 | self.data["Comment"].append(comtag[0].div.text) 82 | except: 83 | self.data["Comment"].append('') 84 | 85 | def get_main_HTML(self, base_URL=None, search_string=None): 86 | ''' 87 | return main html page based on search string 88 | ''' 89 | # construct the search url with base URL and search string 90 | search_url = f"{base_URL}/search?q={search_string}" 91 | # usung urllib read the page 92 | with urllib.request.urlopen(search_url) as url: 93 | page = url.read() 94 | # return the html page after parsing with bs4 95 | return soup(page, "html.parser") 96 | 97 | def get_product_name_links(self, flipkart_base=None, bigBoxes=None): 98 | ''' 99 | returns list of (product name, product link) 100 | ''' 101 | # temporary list to return the results 102 | temp = [] 103 | # iterate over list of bigBoxes 104 | for box in bigBoxes: 105 | try: 106 | # if prod name and list present then append them in temp 107 | temp.append((box.div.div.div.a.img['alt'], 108 | flipkart_base + box.div.div.div.a["href"])) 109 | except: 110 | pass 111 | 112 | return temp 113 | 114 | def get_prod_HTML(self, productLink=None): 115 | ''' 116 | returns each product HTML page after parsing it with soup 117 | ''' 118 | prod_page = requests.get(productLink) 119 | return soup(prod_page.text, "html.parser") 120 | 121 | 122 | def get_data_dict(self): 123 | ''' 124 | returns collected data in dictionary 125 | ''' 126 | return self.data 127 | 128 | def save_as_dataframe(self, dataframe, fileName=None): 129 | ''' 130 | it saves the dictionary dataframe as csv by given filename inside 131 | the CSVs folder and returns the final path of saved csv 132 | ''' 133 | # save the CSV file to CSVs folder 134 | csv_path = os.path.join(app.config['CSV_FOLDER'], fileName) 135 | fileExtension = '.csv' 136 | final_path = f"{csv_path}{fileExtension}" 137 | # clean previous files - 138 | CleanCache(directory=app.config['CSV_FOLDER']) 139 | # save new csv to the csv folder 140 | dataframe.to_csv(final_path, index=None) 141 | print("File saved successfully!!") 142 | return final_path 143 | 144 | 145 | def save_wordcloud_image(self, dataframe=None, img_filename=None): 146 | ''' 147 | it generates and saves the wordcloud image into wc_folder 148 | ''' 149 | # extract all the comments 150 | txt = dataframe["Comment"].values 151 | # generate the wordcloud 152 | wc = WordCloud(width=800, height=400, background_color='black', stopwords=STOPWORDS).generate(str(txt)) 153 | 154 | plt.figure(figsize=(20,10), facecolor='k', edgecolor='k') 155 | plt.imshow(wc, interpolation='bicubic') 156 | plt.axis('off') 157 | plt.tight_layout() 158 | # create path to save wc image 159 | image_path = os.path.join(app.config['IMG_FOLDER'], img_filename + '.png') 160 | # Clean previous image from the given path 161 | CleanCache(directory=app.config['IMG_FOLDER']) 162 | # save the image file to the image path 163 | plt.savefig(image_path) 164 | plt.close() 165 | print("saved wc") 166 | 167 | 168 | class CleanCache: 169 | ''' 170 | this class is responsible to clear any residual csv and image files 171 | present due to the past searches made. 172 | ''' 173 | def __init__(self, directory=None): 174 | self.clean_path = directory 175 | # only proceed if directory is not empty 176 | if os.listdir(self.clean_path) != list(): 177 | # iterate over the files and remove each file 178 | files = os.listdir(self.clean_path) 179 | for fileName in files: 180 | print(fileName) 181 | os.remove(os.path.join(self.clean_path,fileName)) 182 | print("cleaned!") 183 | 184 | # route to display the home page 185 | @app.route('/',methods=['GET']) 186 | @cross_origin() 187 | def homePage(): 188 | return render_template("index.html") 189 | 190 | # route to display the review page 191 | @app.route('/review', methods=("POST", "GET")) 192 | @cross_origin() 193 | def index(): 194 | if request.method == 'POST': 195 | try: 196 | # get base URL and a search string to query the website 197 | base_URL = 'https://www.flipkart.com' # 'https://www.' + input("enter base URL: ") 198 | 199 | # enter a product name eg "xiaomi" 200 | # search_string = input("enter a brandname or a product name: ") 201 | search_string = request.form['content'] 202 | 203 | # fill the spaces between seA caption for the above image.arch strings with + 204 | search_string = search_string.replace(" ", "+") 205 | print('processing...') 206 | 207 | # start counter to count time in seconds 208 | start = time.perf_counter() 209 | 210 | get_data = DataCollection() 211 | 212 | # store main HTML page for given search query 213 | flipkart_HTML = get_data.get_main_HTML(base_URL, search_string) 214 | 215 | # store all the boxes containing products 216 | bigBoxes = flipkart_HTML.find_all("div", {"class":"_1AtVbE col-12-12"}) 217 | 218 | # store extracted product name links 219 | product_name_Links = get_data.get_product_name_links(base_URL, bigBoxes) 220 | 221 | # iterate over product name and links list 222 | for prodName, productLink in product_name_Links[:4]: 223 | # iterate over product HTML 224 | for prod_HTML in get_data.get_prod_HTML(productLink): 225 | try: 226 | # extract comment boxes from product HTML 227 | comment_boxes = prod_HTML.find_all('div', {'class': '_16PBlm'}) #_3nrCtb 228 | 229 | prod_price = prod_HTML.find_all('div', {"class": "_30jeq3 _16Jk6d"})[0].text 230 | prod_price = float((prod_price.replace("₹", "")).replace(",", "")) 231 | # iterate over comment boxes to extract required data 232 | for commentbox in comment_boxes: 233 | # prpare final data 234 | get_data.get_final_data(commentbox, prodName, prod_price) 235 | 236 | except: 237 | pass 238 | 239 | # save the data as gathered in dataframe 240 | df = pd.DataFrame(get_data.get_data_dict()) 241 | 242 | # save dataframe as a csv which will be availble to download 243 | download_path = get_data.save_as_dataframe(df, fileName=search_string.replace("+", "_")) 244 | 245 | # generate and save the wordcloud image 246 | get_data.save_wordcloud_image(df, 247 | img_filename=search_string.replace("+", "_")) 248 | 249 | # finish time counter and calclulate time taked to complet ethis programe 250 | finish = time.perf_counter() 251 | print(f"program finished with and timelapsed: {finish - start} second(s)") 252 | return render_template('review.html', 253 | tables=[df.to_html(classes='data')], # pass the df as html 254 | titles=df.columns.values, # pass headers of each cols 255 | search_string = search_string, # pass the search string 256 | download_csv=download_path # pass the download path for csv 257 | ) 258 | except Exception as e: 259 | print(e) 260 | # return 404 page if error occurs 261 | return render_template("404.html") 262 | 263 | else: 264 | # return index page if home is pressed or for the first run 265 | return render_template("index.html") 266 | 267 | # route to display wordcloud 268 | @app.route('/show') 269 | @cross_origin() 270 | def show_wordcloud(): 271 | img_file = os.listdir(app.config['IMG_FOLDER'])[0] 272 | full_filename = os.path.join(app.config['IMG_FOLDER'], img_file) 273 | return render_template("show_wc.html", user_image = full_filename) 274 | 275 | if __name__ == '__main__': 276 | app.run(debug=True) 277 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------