copy-spotter - GitLite

KO | EN

gitlite — search

#javascript #react #golang #android #rust #deep-learning #macos #nodejs #awesome #vue #awesome-list #security #ios #openai

copy-spotter

(★ 58)

Make plagiarism detection easier. This script will find similar sentences between given files and highlight them in a side by side comparison.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- - example.gif
- __init__.py
- html_utils.py
- html_writing.py
- main.py
- processing_files.py
- similarity.py
- template.html
- utils.py
- - __init__.py
  - test_html_utils.py
  - test_html_writing.py
  - test_main.py
  - test_processing_files.py
  - test_similarity.py
  - test_utils.py
- __init__.py
.gitignore
.pre-commit-config.yaml
CHANGELOG.md
LICENSE
MANIFEST.in
README.md
requirements.txt
requirements_lint.txt
setup.cfg
setup.py
VERSION

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/Wazzabeee/copy-spotter

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd copy-spotter

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Python

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

$ pip install copy-spotter

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

$ pip install -r requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

$ pip install -r requirements_lint.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

$ pip install pre-commit

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

$ pip install pytest

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Copy Spotter

![PyPI - Version](https://img.shields.io/pypi/v/copy-spotter) ![PyPI - License](https://img.shields.io/pypi/l/copy-spotter)
![Python](https://img.shields.io/badge/python-3.11-blue)

![GIF demo](https://raw.githubusercontent.com/Wazzabeee/copy-spotter/main/data/img/example.gif)

## About
This program will process pdf, txt, docx, and odt files that can be found in the given input directory, find similar sentences, calculate similarity percentage, display a similarity table with links to side by side comparison where similar sentences are highlighted.

**Usage**
---

```bash
$ pip install copy-spotter
$ copy-spotter [-s] [-o] [-h] input_directory
```
***Positional Arguments:***
* `input_directory`: One directory that contains all files (pdf, txt, docx, odt) (see `data/pdf/plagiarism` for example)

```
input_directory/
│
├── file_1.docx
├── file_2.pdf
└── file_3.pdf
```

***Optional Arguments:***
* `-s`, `--block-size`: Set minimum number of consecutive and similar words detected. (Default is 2)
* `-o`, `--out_dir`: Set the output directory for html files. (Default is creating a new directory called results)
* `-h`, `--help`: Show this message and exit.

**Examples**
---
```bash
# Analyze documents in 'data/pdf/plagiarism', with default settings
$ copy-spotter data/pdf/plagiarism

# Analyze with custom block size and specify output directory
$ copy-spotter data/pdf/plagiarism -s 5 -o results/output
```

**Development Setup:**
---

```bash
# Clone this repository
$ git clone https://github.com/Wazzabeee/copy_spotter

# Go into the repository
$ cd copy_spotter

# Install requirements
$ pip install -r requirements.txt
$ pip install -r requirements_lint.txt

# Install precommit
$ pip install pre-commit
$ pre-commit install

# Run tests
$ pip install pytest
$ pytest tests/

# Run package locally
$ python -m scripts.main [-s] [-o] [-h] input_directory
```

**Recommandations**
---
- Please make sure that all text files are closed before running the program.
- In order to get the best results please provide text files of the same languages.
- Pdf files that are made from scanned images won't be processed correctly.
- Ensure you have writing access when using the package 
- If a specific file is not processed correctly feel free to [contact me](mailto:<clement45.delteil45@gmail.com>) so that I can address the issue.

**TODO**
---
- Add more tests on existing functions
- Implement OCR with tesseract for scanned documents
- Add custom naming option for pdf files