Skip to main content

Moss Results scraper with powerful insights & analysis

Project description

PlagCheck ✅

Moss Results scraper with powerful insights & analysis 💡

PyPI Build Status PyPI - Python Version Documentation Status PyPI - License PyPI - Downloads

Installation

Install using pip from PyPI

pip install plagcheck

or directly from GitHub if you cannot wait to test new features

pip install git+https://github.com/codeclassroom/PlagCheck.git

Usage

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

Development

Prerequisites
  • Python 3.6+
  • virtualenv
  1. Create virtual environment.
virtualenv -p python3 venv && cd venv && source bin/activate
  1. Clone the repository.
git https://github.com/codeclassroom/PlagCheck.git
  1. Install Dependencies.
pip install -r requirements-dev.txt
  1. Run tests.
pytest plagcheck
  1. Lint the project with
flake8 plagcheck --max-line-length=88 --ignore=F401
black --check --diff plagcheck

📝 Changelog

See the CHANGELOG.md file for details.

Author

👥 Bhupesh Varshney

forthebadge

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

👋 Contributing

Please read the CONTRIBUTING guidelines for the process of submitting pull requests to us.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alexey Dubrov
Alexey Dubrov

💻 🐛 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plagcheck-0.4.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

plagcheck-0.4-py3-none-any.whl (7.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page