Copy Spotter
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
$ 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) (seedata/pdf/plagiarismfor 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
# 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:
# 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 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
Metadata
Release files for copy-spotter 0.1.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| copy-spotter-0.1.16.tar.gz | 12.4 kB | Without provenance | Details for copy-spotter-0.1.16.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| copy_spotter-0.1.16-py3-none-any.whl | Python 3 | none | any | Details for copy_spotter-0.1.16-py3-none-any.whl |
Total release size: 27.6 kB
Release files / copy-spotter-0.1.16.tar.gz
| Download URL | copy-spotter-0.1.16.tar.gz |
|---|---|
| Size | 12.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3051ebb7d5f3384b7c2279d92520f1a6f7d2e9f0a3ed8333ec3136011dacd13
|
|
BLAKE2b-256 checksum How to use checksums |
d8ad4d9ebc88ccd251829d1187cc5248aab12fa9192e24553905caa0b90dd9e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.5
|
Release files / copy_spotter-0.1.16-py3-none-any.whl
| Download URL | copy_spotter-0.1.16-py3-none-any.whl |
|---|---|
| Size | 15.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de87eef4e86489ab4c19c08280479fd5cb66b610c3bd548ada2a0c770751e3b3
|
|
BLAKE2b-256 checksum How to use checksums |
59e4ce25adf112a925b259ecdfde91f19c36c7e7b5d897af7e0751677dfb64cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.5
|
Security for copy-spotter 0.1.16
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.