[DOC] Updated readme and add License docstring for the crawler

HackerSpace-PESU · Jan 5, 2021 · ef58124 · ef58124
1 parent 4ee7c39
commit ef58124
Show file tree

Hide file tree

Showing 10 changed files with 128 additions and 151 deletions.
diff --git a/Dataset.md b/Dataset.md
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ In the past year or so fantasy cricket has been getting a lot of traction and wi
 1. [FastAPI](https://fastapi.tiangolo.com/)
 2. [sklearn](https://scikit-learn.org/stable/)
 3. [pycricbuzz](https://github.com/codophobia/pycricbuzz) 
+4. [scrapy](https://docs.scrapy.org/en/latest/)
 
 Install using </br>
 ```bash
@@ -28,9 +29,9 @@ cd Best11-Fantasycricket
 
 3. Run the model : 
 
-`uvicorn main:app --reload`
+`uvicorn app.main:app --reload`
 
-5. Open http://127.0.0.1:8000/  and voila!! 
+5. Open http://localhost:8000/  and voila!! 
 
 ## How do you verify your model??
 

diff --git a/app/fantasy_cricket/templates/Playing_11.html b/app/fantasy_cricket/templates/Playing_11.html
@@ -1,4 +1,19 @@
 <!DOCTYPE html>
+<!--Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
 <html>
 <head>
 	<title>Choose your playing 11</title>

diff --git a/crawler/__init__.py b/crawler/__init__.py
@@ -1,3 +1,19 @@
+"""
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 import sys
 
 sys.path.insert(1, "..")
diff --git a/crawler/fantasy_leagues.py b/crawler/fantasy_leagues.py
@@ -1,6 +1,21 @@
+
 """
 This modules defines all the fantasy leagues that
 the project supports
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
 

diff --git a/crawler/items.py b/crawler/items.py
@@ -3,6 +3,22 @@
 # See documentation in:
 # https://docs.scrapy.org/en/latest/topics/items.html
 
+"""
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 import scrapy
 
 

diff --git a/crawler/pipelines.py b/crawler/pipelines.py
@@ -3,7 +3,22 @@
 # Don't forget to add your pipeline to the ITEM_PIPELINES setting
 # See: https://docs.scrapy.org/en/latest/topics/item-pipeline.html
 
+"""
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
 
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 # useful for handling different item types with a single interface
 from itemadapter import ItemAdapter
 from statistics import mode

diff --git a/crawler/settings.py b/crawler/settings.py
@@ -1,3 +1,19 @@
+"""
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 # Scrapy settings for cricketcrawler project
 #
 # For simplicity, this file contains only settings considered important or

diff --git a/crawler/spiders/__init__.py b/crawler/spiders/__init__.py
@@ -2,6 +2,22 @@
 #
 # Please refer to the documentation for information on how to create and manage
 # your spiders.
+"""
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 
 import sys
 

diff --git a/crawler/spiders/howstat.py b/crawler/spiders/howstat.py
@@ -1,3 +1,19 @@
+"""
+    Copyright (C) 2020  Royston E Tauro & Sammith S Bharadwaj & Shreyas Raviprasad
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
 from dateutil.parser import parse as dateparse
 from scrapy import Request, Spider
 from crawler.fantasy_leagues import Dream11