ready for 0.3

Author: Bhupesh-V

.travis.yml

@@ -5,9 +5,9 @@ python:
   - "3.8"
 
 install:
-  - pip install -r requirements.txt
+  - pip install -r requirements-dev.txt
   - pip install isort black flake8 pylint
-  - pip install pytest coveralls
+  - pip install coveralls
 script:
   - pytest plagcheck
   - py.test plagcheck/plagcheck_test.py

README.md

@@ -1,84 +1,98 @@
 # PlagCheck ✅
 
+> Moss Results scraper with powerful insights & analysis 💡
+
 ![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)
 [![Documentation Status](https://readthedocs.org/projects/plagcheck/badge/?version=latest)](https://plagcheck.readthedocs.io/en/latest/?badge=latest)
-[![GitHub license](https://img.shields.io/github/license/codeclassroom/PlagCheck)](https://github.com/codeclassroom/CodeRunner/blob/master/LICENSE)
+![PyPI - License](https://img.shields.io/pypi/l/plagcheck)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/plagcheck?color=blue)
 
 
-> A Powerful [MOSS](http://theory.stanford.edu/~aiken/moss/) results scrapper.
-
-## Installation 🔮
-
-1. Create virtual environment.
+## Installation
 
-    **Linux/MacOS**
+Install using `pip` from PyPI
 
-    ```bash
-    virtualenv -p python3 venv && cd venv && source bin/activate
-    ```
+```bash
+pip install plagcheck
+```
 
-    **Windows**
-    (*PowerShell*)
+or directly from GitHub if you cannot wait to test new features
 
-    ```cmd
-    py -m venv venv; .\venv\Scripts\activate;
-    ```
+```bash
+pip install git+https://github.com/codeclassroom/PlagCheck.git
+```
 
-2. Clone the repository.
+## Usage
 
-    ```bash
-    git clone https://github.com/codeclassroom/PlagCheck.git
-    ```
+```python
 
-3. Install dependencies.
+"""Usage example"""
+import os
+import pprint
+from plagcheck import plagcheck
 
-    ```bash
-    pip install -r requirements.txt
-    ```
+from dotenv import load_dotenv
+load_dotenv()
 
-4. Set-up virtual environment variables.
-    1. Create a file named `.env` in the root directory & add the following contents.
+language = "python"
+userid = os.environ["USER_ID"]
 
-        ```text
-        USER_ID = 'moss-user-id'
-        ```
 
-    2. For `USER_ID` read instructions on [Moss](http://theory.stanford.edu/~aiken/moss/).
+moss = plagcheck.check(language, userid)
 
-5. Run `demo.py` for demo.
+moss.addFilesByWildCard("testfiles/test_python*.py")
 
-## Usage
+# or moss.addFile("testfiles/test_python.py")
 
-Install the package.
+moss.submit()
 
-```bash
-pip install plagcheck
+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())
 ```
 
-```python
-"""Usage example"""
-import os
-import pprint
-import plagcheck
-from dotenv import load_dotenv
-load_dotenv()
+## Documentation
 
-program_files = ["testfiles/test_python.py", "testfiles/test_python3.py"]
-language = "python"
-userid = os.environ["USER_ID"]
+> [PlagCheck Documentation](https://plagcheck.readthedocs.io/en/latest/)
 
-url, results = plagcheck.check(program_files, language, userid)
 
+## Development
 
-print(url)
-pprint.pprint(results)
+##### Prerequisites
+- Python 3.6+
+- virtualenv
 
+1. Create virtual environment.
+```bash
+virtualenv -p python3 venv && cd venv && source bin/activate
+```
+2. Clone the repository.
+```bash
+git https://github.com/codeclassroom/PlagCheck.git
+```
+3. Install Dependencies.
+```bash
+pip install -r requirements.txt
 ```
+4. Run tests.
+```bash
+pytest plagcheck
+```
+5. Lint the project with
+```bash
+flake8 plagcheck --max-line-length=88 --ignore=F401
+black --check --diff plagcheck
+```
+
+## 📝 Changelog
+
+See the [CHANGELOG.md](CHANGELOG.md) file for details.
 
-Read [Documentation](https://github.com/codeclassroom/PlagCheck/blob/master/docs/docs.md).
 
 ## Author
 
@@ -87,6 +101,17 @@ Read [Documentation](https://github.com/codeclassroom/PlagCheck/blob/master/docs
 - Twitter: [@bhupeshimself](https://twitter.com/bhupeshimself)
 - DEV: [bhupesh](https://dev.to/bhupesh)
 
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
+
+## 📜 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## 👋 Contributing
+
+Please read the [CONTRIBUTING](CONTRIBUTING.md) guidelines for the process of submitting pull requests to us.
+
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

requirements.txt renamed to requirements-dev.txt

@@ -1,4 +1,5 @@
 mosspy
 beautifulsoup4
 lxml
-python-dotenv
+python-dotenv
+pytest

setup.py

@@ -9,7 +9,7 @@
     license="MIT",
     author="Bhupesh Varshney",
     author_email="[email protected]",
-    description="Moss scraper with powerful insights",
+    description="Moss Results scraper with powerful insights & analysis",
     keywords="moss plagiarism analysis cheat mosspy",
     long_description=long_description,
     long_description_content_type="text/markdown",