Merge pull request #5 from codeclassroom/dev

0.3 release

Author: Bhupesh-V

.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.

.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: ''
 
 ---

.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: ''

.gitignore

@@ -102,3 +102,7 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# custom
+/submission
+sample.py

.travis.yml

@@ -14,6 +14,6 @@ script:
   - isort --check-only --recursive plagcheck
   - black --check --diff plagcheck
   - flake8 plagcheck --max-line-length=88 --ignore=F401
-  - pylint plagcheck --disable=bad-continuation,invalid-name
+  - pylint plagcheck --disable=bad-continuation,invalid-name,attribute-defined-outside-init,no-self-use,too-many-locals,too-few-public-methods
 after_success:
   - coveralls

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.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Bhupesh Varshney
+Copyright (c) 2020 Bhupesh Varshney
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

_config.yml

@@ -0,0 +1,2 @@
+theme: jekyll-theme-slate
+show_downloads: true

demo.py

@@ -2,15 +2,25 @@
 import os
 import pprint
 from plagcheck import plagcheck
+
 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)
 
+moss = plagcheck.check(language, userid)
+
+moss.addFilesByWildCard("testfiles/test_python*.py")
+
+# or moss.addFile("testfiles/test_python.py")
+
+moss.submit()
 
-print(url)
-pprint.pprint(results)
+print(moss.getHomePage())
+pprint.pprint(moss.getResults())
+# print frequency of each shared solution
+pprint.pprint(moss.getShareScores())
+# print potential distributor-culprit relationships
+pprint.pprint(moss.getInsights())

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.