Metadata-Version: 2.1
Name: plagcheck
Version: 0.4
Summary: Moss Results scraper with powerful insights & analysis
Home-page: https://codeclassroom.github.io/PlagCheck/
Author: Bhupesh Varshney
Author-email: varshneybhupesh@gmail.com
License: MIT
Project-URL: Documentation, https://plagcheck.readthedocs.io/en/latest/?badge=latest
Project-URL: Source Code, https://github.com/codeclassroom/PlagCheck
Project-URL: Funding, https://www.patreon.com/bePatron?u=18082750
Project-URL: Say Thanks!, https://github.com/codeclassroom/PlagCheck/issues/new?assignees=&labels=&template=---say-thank-you.md&title=
Project-URL: Tracker, https://github.com/codeclassroom/PlagCheck/issues
Description: # 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)
        ![PyPI - License](https://img.shields.io/pypi/l/plagcheck?color=orange)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/plagcheck?color=blue)
        
        
        ## Installation
        
        Install using `pip` from PyPI
        
        ```bash
        pip install plagcheck
        ```
        
        or directly from GitHub if you cannot wait to test new features
        
        ```bash
        pip install git+https://github.com/codeclassroom/PlagCheck.git
        ```
        
        ## Usage
        
        ```python
        
        """Usage example"""
        import os
        import pprint
        from plagcheck import plagcheck
        
        from dotenv import load_dotenv
        load_dotenv()
        
        language = "python"
        userid = os.environ["USER_ID"]
        
        
        moss = plagcheck.check(language, userid)
        
        moss.addFilesByWildCard("testfiles/test_python*.py")
        
        # or moss.addFile("testfiles/test_python.py")
        
        moss.submit()
        
        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())
        ```
        
        ## Documentation
        
        > [PlagCheck Documentation](https://plagcheck.readthedocs.io/en/latest/)
        
        
        ## Development
        
        ##### 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-dev.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.
        
        
        ## Author
        
        👥 **Bhupesh Varshney**
        
        - 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)):
        
        <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
        <!-- prettier-ignore -->
        <table>
          <tr>
            <td align="center"><a href="https://github.com/vhsw"><img src="https://avatars3.githubusercontent.com/u/7099976?v=4" width="100px;" alt="Alexey Dubrov"/><br /><sub><b>Alexey Dubrov</b></sub></a><br /><a href="https://github.com/codeclassroom/PlagCheck/commits?author=vhsw" title="Code">💻</a> <a href="https://github.com/codeclassroom/PlagCheck/issues?q=author%3Avhsw" title="Bug reports">🐛</a> <a href="https://github.com/codeclassroom/PlagCheck/commits?author=vhsw" title="Tests">⚠️</a></td>
          </tr>
        </table>
        
        <!-- ALL-CONTRIBUTORS-LIST:END -->
        
        This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
        
Keywords: moss plagiarism analysis cheat mosspy
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Education
Classifier: Topic :: Education
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
