plagdef


Nameplagdef JSON
Version 0.6 PyPI version JSON
download
home_pagehttps://github.com/devWhyqueue/plagdef
SummaryA tool which makes life hard for students who try to make theirs simple.
upload_time2021-05-06 13:40:36
maintainer
docs_urlNone
authorYannik Queisler
requires_python>=3.7
licenseMIT license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)
[![Test](https://github.com/devWhyqueue/plagdef/actions/workflows/test.yml/badge.svg)](https://github.com/devWhyqueue/plagdef/actions/workflows/test.yml)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devWhyqueue_plagdef&metric=coverage)](https://sonarcloud.io/dashboard?id=devWhyqueue_plagdef)

A tool which makes life hard for students who try to make theirs simple.

# Installation

Get it from PyPI:

```
$ pip install plagdef
````

Or build it yourself:

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

# Requirements

## OCRMyPDF

This library is used for improved PDF text extraction.\
To install its necessary dependencies for your operating system take a look at:\
https://ocrmypdf.readthedocs.io/en/latest/installation.html

And don't forget to download the German language pack to your _tessdata_ folder from here:\
https://github.com/tesseract-ocr/tessdata

## Libmagic

**After** (important!) you installed PlagDef, install the libmagic library.\
PlagDef uses it to detect character encodings.\
Further instructions can be found here:\
https://github.com/ahupp/python-magic#installation

# Usage

Run the GUI:

```
$ plagdef-gui
````

Or if you prefer a CLI:

```
$ plagdef -h
````

# Development

Clone the repo and install dependencies:

```
$ git clone git://github.com/devWhyqueue/plagdef
$ pipenv install --dev
````

# Publish to PyPI

In your virtual environment build and upload PlagDef:

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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/devWhyqueue/plagdef",
    "name": "plagdef",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Yannik Queisler",
    "author_email": "dev.yannik.queisler@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/31/e8/311d55cb177c7921305d952a149bd4d2d377aebdc3e36eb8d6c261040a0f/plagdef-0.6.tar.gz",
    "platform": "",
    "description": "# PlagDef\n\n[![PyPI version](https://badge.fury.io/py/plagdef.svg)](https://badge.fury.io/py/plagdef)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/plagdef)\n![GitHub](https://img.shields.io/github/license/devWhyqueue/plagdef)\n[![Test](https://github.com/devWhyqueue/plagdef/actions/workflows/test.yml/badge.svg)](https://github.com/devWhyqueue/plagdef/actions/workflows/test.yml)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devWhyqueue_plagdef&metric=coverage)](https://sonarcloud.io/dashboard?id=devWhyqueue_plagdef)\n\nA tool which makes life hard for students who try to make theirs simple.\n\n# Installation\n\nGet it from PyPI:\n\n```\n$ pip install plagdef\n````\n\nOr build it yourself:\n\n```\n$ git clone git://github.com/devWhyqueue/plagdef\n$ python -m pip install -e .\n````\n\n# Requirements\n\n## OCRMyPDF\n\nThis library is used for improved PDF text extraction.\\\nTo install its necessary dependencies for your operating system take a look at:\\\nhttps://ocrmypdf.readthedocs.io/en/latest/installation.html\n\nAnd don't forget to download the German language pack to your _tessdata_ folder from here:\\\nhttps://github.com/tesseract-ocr/tessdata\n\n## Libmagic\n\n**After** (important!) you installed PlagDef, install the libmagic library.\\\nPlagDef uses it to detect character encodings.\\\nFurther instructions can be found here:\\\nhttps://github.com/ahupp/python-magic#installation\n\n# Usage\n\nRun the GUI:\n\n```\n$ plagdef-gui\n````\n\nOr if you prefer a CLI:\n\n```\n$ plagdef -h\n````\n\n# Development\n\nClone the repo and install dependencies:\n\n```\n$ git clone git://github.com/devWhyqueue/plagdef\n$ pipenv install --dev\n````\n\n# Publish to PyPI\n\nIn your virtual environment build and upload PlagDef:\n\n```\n$ python -m build\n$ twine upload dist/*\n````\n\n\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "A tool which makes life hard for students who try to make theirs simple.",
    "version": "0.6",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b4be1e394830b319f19518076ba2e7ae",
                "sha256": "3f1fd35f0c5e05670671fcef2283db1258c6d8a8fd19384ba581e77910f4ce45"
            },
            "downloads": -1,
            "filename": "plagdef-0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b4be1e394830b319f19518076ba2e7ae",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 387271,
            "upload_time": "2021-05-06T13:40:34",
            "upload_time_iso_8601": "2021-05-06T13:40:34.748914Z",
            "url": "https://files.pythonhosted.org/packages/84/02/9d84f7f03c979fc5e0946b695a412c2c18a62e842b8158574dd3063e6d5c/plagdef-0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "5f4ec815adc73b39ad9e7c3ed39d379c",
                "sha256": "2fd38c401b16ff30f7b20ad6d48e0943398e6a0b32a07836f9c19ef34cc87b53"
            },
            "downloads": -1,
            "filename": "plagdef-0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "5f4ec815adc73b39ad9e7c3ed39d379c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 368725,
            "upload_time": "2021-05-06T13:40:36",
            "upload_time_iso_8601": "2021-05-06T13:40:36.422783Z",
            "url": "https://files.pythonhosted.org/packages/31/e8/311d55cb177c7921305d952a149bd4d2d377aebdc3e36eb8d6c261040a0f/plagdef-0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-05-06 13:40:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "devWhyqueue",
    "error": "Could not fetch GitHub repository",
    "lcname": "plagdef"
}
        
Elapsed time: 0.27131s