ton of improvements

Bhupesh-V · Bhupesh-V · commit 13b6ef9a65b4 · 2019-12-20T19:52:57.000+05:30
- Added Docs
- Modularised whole code. check is now a class
- minor configs
diff --git a/.github/ISSUE_TEMPLATE/----bug-report.md b/.github/ISSUE_TEMPLATE/----bug-report.md
@@ -2,7 +2,7 @@
 name: "\U0001F41B  Bug report"
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: 'bug'
 assignees: ''
 
 ---
@@ -28,11 +28,5 @@ If applicable, add screenshots to help explain your problem.
  - Browser [e.g. chrome, safari]
  - Version [e.g. 22]
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md
@@ -2,7 +2,7 @@
 name: "\U0001F680 Feature request"
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'enhancement'
 assignees: ''
 
 ---
diff --git a/.github/ISSUE_TEMPLATE/---say-thank-you.md b/.github/ISSUE_TEMPLATE/---say-thank-you.md
@@ -1,6 +1,6 @@
 ---
 name: "\U0001F49F Say thank you"
-about: Just say thanks if you liked tutorialdb
+about: Just say thanks if you liked PlagCheck
 title: ''
 labels: ''
 assignees: ''
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Contributing to PlagCheck
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+Make sure you follow below guidelines before contributing.
+
+1. Raise an issue before sending any PR.
+2. Make you changes to `feature` branch.
+3. See if there is already an open PR for the same issue.
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,2 @@
+theme: jekyll-theme-slate
+show_downloads: true
diff --git a/demo.py b/demo.py
@@ -2,15 +2,18 @@
 import os
 import pprint
 from plagcheck import plagcheck
+import time
 from dotenv import load_dotenv
 load_dotenv()
 
 program_files = ["testfiles/test_python.py", "testfiles/test_python3.py"]
 language = "python"
 userid = os.environ["USER_ID"]
 
-url, results = plagcheck.check(program_files, language, userid)
 
+cheat = plagcheck.check(program_files, language, userid)
 
-print(url)
-pprint.pprint(results)
+cheat.submit()
+
+print(cheat.getHomePage())
+pprint.pprint(cheat.getResults())
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,17 @@
+## About
+
+plagcheck was built by :
+
+👥 **Bhupesh Varshney**
+
+- Twitter: [@bhupeshimself](https://twitter.com/bhupeshimself)
+- DEV: [bhupesh](https://dev.to/bhupesh)
+- GitHub: [Bhupesh-V](https://github.com/Bhupesh-V)
+
+## 📝 License
+
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/codeclassroom/PlagCheck/blob/master/LICENSE) file for details.
+
+## 👋 Contributing
+
+Please read the [CONTRIBUTING](https://github.com/codeclassroom/PlagCheck/blob/master/CONTRIBUTING.md) guidelines for the process of submitting pull requests to us.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,24 @@
+# Changelog
+
+
+## [0.3] - Dec x, 2019
+
+### Added
+- New methods: `getHomePage()`, `submit()`, `getResults()`, `addBase()`. See Documentation for usage.
+
+### Changed
+- The plagcheck module, more modularised. `check` is now a class.
+
+### Removed
+- `requests` as a dependency, network requests are now 50% faster.
+
+
+## [0.2] - Nov 9, 2019
+- Minor Improvements
+
+
+## [0.1] - Nov 3, 2019
+- Initial Release
+
+# Releases
+See releases on [PyPi](https://pypi.org/project/plagcheck/#history)
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,9 @@
+# PlagCheck ✅
+
+![PyPI](https://img.shields.io/pypi/v/plagcheck?color=blue)
+[![Build Status](https://travis-ci.org/codeclassroom/PlagCheck.svg?branch=master)](https://travis-ci.org/codeclassroom/PlagCheck)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/plagcheck)
+[![GitHub license](https://img.shields.io/github/license/codeclassroom/PlagCheck)](https://github.com/codeclassroom/CodeRunner/blob/master/LICENSE)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/plagcheck?color=blue)
+[![GitHub issues](https://img.shields.io/github/issues/codeclassroom/PlagCheck?color=blueviolet)](https://github.com/codeclassroom/CodeRunner/issues)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](http://makeapullrequest.com)
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,17 @@
+# Installation
+
+Installing plagcheck is pretty simple, just run
+
+`pip install plagcheck`
+
+Install a specific verison 
+
+`pip install plagcheck==0.2`
+
+or directly from GitHub if you cannot wait to test new features
+
+`pip install git+https://github.com/codeclassroom/PlagCheck.git`
+
+If you have already installed it and want to update
+
+`pip install --upgrade plagcheck`
diff --git a/docs/usage.md b/docs/usage.md
@@ -47,7 +47,7 @@ The homepage link of the results for each submission to MOSS.
 
 - Moss can be more accurate if a base file is supplied. The -b option to Moss supplies a base file of code that should be ignored if it appears in programs; Moss never considers code that appears in a base file to match any other code. If your results include many unintended matches, then it is best to place all legitimately shared code in a base file (e.g., instructor-supplied code, common libraries, etc.) and resubmit the query to the server.
 
-- Moss is a computer program that detects structural similarities in programs and nothing more; it has no idea why programs may be structurally similar. As noted above, there are reasons besides plagiarism that two programs may appear the same (e.g., they are both based on the same third program, such as instructor-supplied code for an assignment). Results from Moss cannot be taken as direct evidence of plagiarism---it is still necessary for someone to examine the programs and make a judgment. 
+- Moss detects structural similarities in programs and nothing more; it has no idea why programs may be structurally similar. As noted above, there are reasons besides plagiarism that two programs may appear the same (e.g., they are both based on the same third program, such as instructor-supplied code for an assignment). Results from Moss cannot be taken as direct evidence of plagiarism---it is still necessary for someone to examine the programs and make a judgment. 
 
 ## Credits
 Moss was written and is maintained by Alex Aiken, aiken@cs.stanford.edu.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,16 @@
+site_name: PlagCheck
+site_url: https://codeclassroom.github.io/PlagCheck/
+repo_url: https://github.com/codeclassroom/PlagCheck
+site_author: Bhupesh Varshney
+site_description: PlagCheck v0.3 Documentation
+copyright: © 2019, Bhupesh Varshney
+nav:
+    - Documentation: index.md
+    - Installation: installation.md
+    - Usage: usage.md
+    - Changelog: changelog.md
+    - About: about.md
+theme: readthedocs
+markdown_extensions:
+    - toc:
+        permalink: "#"
diff --git a/plagcheck/plagcheck.py b/plagcheck/plagcheck.py
@@ -3,14 +3,14 @@
 from typing import List, Tuple
 
 import mosspy
-import requests
+import urllib.request
 from bs4 import BeautifulSoup as bs
 
 HEADERS = {"User-Agent": "Mozilla/5.0"}
 
 
 class Result(dict):
-    """Typing for results"""
+    """Typing for moss results"""
 
     file1: str
     file2: str
@@ -22,66 +22,101 @@ class Result(dict):
 Results = List[Result]
 
 
-def download_report(url: str):
-    """Download whole report locally including code diff links"""
-    mosspy.download_report(url, "submission/report/", connections=8)
-
-
-def check(program_files: list, lang: str, user_id: str) -> Tuple[str, Results]:
-    """Check files for same lines"""
-    languages = mosspy.Moss.languages
-    if lang not in languages:
-        raise ValueError(f"{lang} is not in supported languiges {languages}")
-    moss = mosspy.Moss(user_id, lang)
-    for item in program_files:
-        moss.addFile(item)
-    url = moss.send()
-    results = __extract_info(url)
-    return url, results
-
-
-def __extract_info(url: str) -> Results:
-    """Scrape the webpage for file names, percentage match etc."""
-    results: Results = []
-    res = requests.get(url, headers=HEADERS)
-    html = bs(res.text, "lxml")
-    table = html.find("table")
-    for row in table.find_all("tr")[1:]:
-        col1, col2, col3 = row.find_all("td")
-        filename1, perc = col1.text.strip().split()
-        filename2, ____ = col2.text.strip().split()
-        result_dict = Result(
-            file1=filename1,
-            file2=filename2,
-            percentage=perc_str_to_int(perc),
-            no_of_lines_matched=int(col3.text.strip()),
-            lines_matched=__get_line_numbers(col1.a.get("href")),
-        )
-        results.append(result_dict)
-    return results
-
-
-def __get_line_numbers(url: str) -> List[List[str]]:
-    """Get Line Numbers which are same"""
-
-    list_of_line_nos: List[List[str]] = []
-    result_page = re.sub(r".html$", "-top.html", url)
-    res = requests.get(result_page, headers=HEADERS)
-    html = bs(res.text, "lxml")
-    table = html.find("table")
-    for row in table.find_all("tr")[1:]:
-        matched_lines: List[str] = []
-        for col in row.find_all("td"):
-            line_nos: str = col.text.strip()
-            if line_nos:
-                matched_lines.append(line_nos)
-        list_of_line_nos.append(matched_lines)
-    return list_of_line_nos
-
-
 def perc_str_to_int(string: str) -> int:
-    """convert string like "(42%)" to 42"""
+    """
+    Convert string like "(42%)" to 42
+    """
     match = re.search(r"\((\d+)%\)$", string)
     if match:
         return int(match.group(1))
-    raise ValueError("cannot find percentage in table")
+    raise ValueError("Cannot find percentage in table")
+
+
+class check:
+    def __init__(self, files: list, lang: str, user_id: str):
+
+        self.__user_id = user_id
+        self.files = files
+        languages = mosspy.Moss.languages
+        if lang not in languages:
+            raise ValueError(f"{lang} is not a supported language {languages}")
+        self.lang = lang
+        self.__moss = mosspy.Moss(self.__user_id, self.lang)
+
+    def __extract_info(self) -> Results:
+        """
+        Scrape the webpage for file names, percentage match etc.
+        """
+        results: Results = []
+
+        req = urllib.request.Request(self.home_url, headers=HEADERS)
+        with urllib.request.urlopen(req) as response:
+            req = response.read()
+
+        html = bs(req.decode("utf-8"), "lxml")
+        table = html.find("table")
+        for row in table.find_all("tr")[1:]:
+            col1, col2, col3 = row.find_all("td")
+            filename1, perc = col1.text.strip().split()
+            filename2, ____ = col2.text.strip().split()
+            result_dict = Result(
+                file1=filename1,
+                file2=filename2,
+                percentage=perc_str_to_int(perc),
+                no_of_lines_matched=int(col3.text.strip()),
+                lines_matched=self.__get_line_numbers(col1.a.get("href")),
+            )
+            results.append(result_dict)
+        return results
+
+    def __get_line_numbers(self, url: str) -> List[List[str]]:
+        """
+        Get Line Numbers which are same
+        """
+        list_of_line_nos: List[List[str]] = []
+        result_page = re.sub(r".html$", "-top.html", url)
+
+        req = urllib.request.Request(result_page, headers=HEADERS)
+        with urllib.request.urlopen(req) as response:
+            req = response.read()
+
+        html = bs(req.decode("utf-8"), "lxml")
+        table = html.find("table")
+        for row in table.find_all("tr")[1:]:
+            matched_lines: List[str] = []
+            for col in row.find_all("td"):
+                line_nos: str = col.text.strip()
+                if line_nos:
+                    matched_lines.append(line_nos)
+            list_of_line_nos.append(matched_lines)
+        return list_of_line_nos
+
+    def addBase(self, base_file: str):
+        """
+        Add basefile
+        """
+        self.__moss.addBaseFile(base_file)
+
+    def submit(self):
+        """
+        Submit files to the Moss Server
+        """
+        for item in self.files:
+            self.__moss.addFile(item)
+        url = self.__moss.send()
+
+        self.home_url = url
+
+    def getHomePage(self):
+        """
+        Return Moss Results HomePage URL
+        """
+        return self.home_url
+
+    def getResults(self) -> Tuple[str, Results]:
+        """
+        Return the result as a list of dictionary
+        """
+        results = self.__extract_info()
+
+        return results
diff --git a/plagcheck/plagcheck_test.py b/plagcheck/plagcheck_test.py
@@ -7,8 +7,9 @@ def test_check():
     program_files = ["testfiles/test_python.py", "testfiles/test_python3.py"]
     language = "python"
     userid = "1"
-    url, results = plagcheck.check(program_files, language, userid)
-    assert "http" in url
+    temp = plagcheck.check(program_files, language, userid)
+    results = temp.getResults()
+
     assert results == [
         {
             "file1": "testfiles/test_python.py",
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,4 @@
 mosspy
 beautifulsoup4
-requests
 lxml
 python-dotenv
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="plagcheck",
-    version="0.2",
+    version="0.3",
     author="Bhupesh Varshney",
     author_email="varshneybhupesh@gmail.com",
     description="A Powerful MOSS results scrapper",
@@ -18,10 +18,10 @@
         "Source Code": "https://github.com/codeclassroom/PlagCheck",
         "Funding": "https://www.patreon.com/bePatron?u=18082750",
         "Say Thanks!": "https://github.com/codeclassroom/PlagCheck/issues/new?assignees=&labels=&template=---say-thank-you.md&title=",
+        "Tracker": "https://github.com/codeclassroom/PlagCheck/issues",
     },
     packages=setuptools.find_packages(),
     install_requires=[
-        'requests',
         'mosspy',
         'beautifulsoup4',
         'lxml',

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+theme: jekyll-theme-slate`
	`2`	`+show_downloads: true`