plagdef


Nameplagdef JSON
Version 1.4.13 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_time2023-02-01 15:22:12
maintainer
docs_urlNone
authorYannik Queisler
requires_python>=3.9,<3.11
licenseGPL-3.0-or-later
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/cd.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
$ poetry build
$ pip install dist/plagdef-{VERSION}.tar.gz
````

# Requirements

## Chrome

PlagDef uses Selenium to automate the translation of documents.
By default, it uses a headless version of Chrome.

## 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
$ poetry install
````

# Publish to PyPI

In your virtual environment build and upload PlagDef:

```
$ poetry publish --build
````

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/devWhyqueue/plagdef",
    "name": "plagdef",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<3.11",
    "maintainer_email": "",
    "keywords": "",
    "author": "Yannik Queisler",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/cb/36/d8ee1f39764fba0808b05346ad9be4f4effcf20c2020e29bb1c0691d9949/plagdef-1.4.13.tar.gz",
    "platform": null,
    "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/cd.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$ poetry build\n$ pip install dist/plagdef-{VERSION}.tar.gz\n````\n\n# Requirements\n\n## Chrome\n\nPlagDef uses Selenium to automate the translation of documents.\nBy default, it uses a headless version of Chrome.\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$ poetry install\n````\n\n# Publish to PyPI\n\nIn your virtual environment build and upload PlagDef:\n\n```\n$ poetry publish --build\n````\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A tool which makes life hard for students who try to make theirs simple.",
    "version": "1.4.13",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0fe2185a3dda9008fc62129406d596004379ae79c594a5be996fdf61f4fce86f",
                "md5": "eb0879d38a085a5c00747db97283abb1",
                "sha256": "2ba1254478db5500c1bc0daf93accd89c49e30f54c39bdc18e19e20724d4d05b"
            },
            "downloads": -1,
            "filename": "plagdef-1.4.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eb0879d38a085a5c00747db97283abb1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<3.11",
            "size": 708066,
            "upload_time": "2023-02-01T15:22:11",
            "upload_time_iso_8601": "2023-02-01T15:22:11.307169Z",
            "url": "https://files.pythonhosted.org/packages/0f/e2/185a3dda9008fc62129406d596004379ae79c594a5be996fdf61f4fce86f/plagdef-1.4.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb36d8ee1f39764fba0808b05346ad9be4f4effcf20c2020e29bb1c0691d9949",
                "md5": "90cc6c6844084d77b483f455a7625637",
                "sha256": "5b19d2880ce8ba91ae34de5e9e5f351dcb9256fbcf35ffc53e207d262e995c28"
            },
            "downloads": -1,
            "filename": "plagdef-1.4.13.tar.gz",
            "has_sig": false,
            "md5_digest": "90cc6c6844084d77b483f455a7625637",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<3.11",
            "size": 688366,
            "upload_time": "2023-02-01T15:22:12",
            "upload_time_iso_8601": "2023-02-01T15:22:12.869713Z",
            "url": "https://files.pythonhosted.org/packages/cb/36/d8ee1f39764fba0808b05346ad9be4f4effcf20c2020e29bb1c0691d9949/plagdef-1.4.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-01 15:22:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "devWhyqueue",
    "github_project": "plagdef",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "plagdef"
}
        
Elapsed time: 0.03590s