Metadata-Version: 2.1
Name: plagdef
Version: 0.1
Summary: PlagDef supports plagiarism detection for student assignments.
Home-page: https://github.com/devWhyqueue/plagdef
Author: Yannik Queisler
Author-email: dev.yannik.queisler@gmail.com
License: MIT license
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# PlagDef

[![PyPI version](https://badge.fury.io/py/plagdef.svg)](https://badge.fury.io/py/plagdef)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/plagdef)
![GitHub](https://img.shields.io/github/license/devWhyqueue/plagdef)
[![Build Status](https://travis-ci.com/devWhyqueue/plagdef.svg?branch=main)](https://travis-ci.com/devWhyqueue/plagdef)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devWhyqueue_plagdef&metric=coverage)](https://sonarcloud.io/dashboard?id=devWhyqueue_plagdef)

PlagDef supports plagiarism detection for student assignments.

# Installation

Get it from PyPI:

```
$ pip install plagdef
````

Or build it yourself:

```
$ git clone git://github.com/devWhyqueue/plagdef
$ pip install -e .
````

And install necessary NLTK data:

```
$ python -m nltk.downloader punkt
````

# Usage

Run the CLI and show help:

```
$ plagdef -h
````

# Development

Clone the repo and install dependencies/resources:

```
$ git clone git://github.com/devWhyqueue/plagdef
$ pipenv install --dev
$ pipenv run python -m nltk.downloader punkt
````

# Publish to PyPI

In your virtual environment build and upload PlagDef:

```
$ python -m build
$ twine upload dist/*
````


