## Copyleaks Python SDK
Copyleaks SDK is a simple framework that allows you to scan textual content for plagiarism and trace content distribution online, using the [Copyleaks plagiarism checker cloud](https://api.copyleaks.com).
Detect plagiarism using Copyleaks SDK in:
* Online content and webpages
* Local and cloud files ([see supported files](https://api.copyleaks.com/GeneralDocumentation/TechnicalSpecifications#supportedfiletypes"))
* Free text
* OCR (Optical Character Recognition) - scanning pictures with textual content ([see supported files](https://api.copyleaks.com/GeneralDocumentation/TechnicalSpecifications#supportedfiletypes))
### Installation
Supported Python version: 3.
You have two ways to integrate with the Copyleaks SDK:
* **Recommended** - Use the Python Package Manager - [PiPy](https://pypi.python.org/pypi/copyleaks).
When integrating this way you will automatically be able to update the SDK to its latest version:
<pre>pip3 install copyleaks
</pre>
* Download the code from this repository and add it to your project.
### Register and Get Your API Key
To use the Copyleaks SDK you need to have a Copyleaks account. The registration to Copyleaks is free of charge and quick. [Sign up](https://api.copyleaks.com/?register=true) and confirm your account to finalize your registration.
Now, generate your personal API key on your [dashboard](https://api.copyleaks.com/dashboard) under 'API Access Credentials'.
For more information check out our [API guide](https://api.copyleaks.com/documentation/v3).
### Examples
See the [example.py](https://github.com/Copyleaks/Python-Plagiarism-Checker/blob/master/example.py) file.
* To change the Identity server URI (default:"https://id.copyleaks.com"):
<pre>Copyleaks.set_identity_uri("your identity server uri");
</pre>
* To change the API server URI (default:"https://api.copyleaks.com"):
<pre>Copyleaks.set_api_uri("your api server uri");
</pre>
### Dependencies
<pre>pip3 install requests pytz python-dateutil
</pre>
### Read More
* [API Homepage](https://api.copyleaks.com)
* [API Documentation](https://api.copyleaks.com/documentation)
* [Plagiarism Report](https://github.com/Copyleaks/plagiarism-report)
Raw data
{
"_id": null,
"home_page": "https://api.copyleaks.com",
"name": "copyleaks",
"maintainer": null,
"docs_url": "https://pythonhosted.org/copyleaks/",
"requires_python": null,
"maintainer_email": null,
"keywords": "copyleaks, api, plagiarism, content, checker, online, academic, publishers, websites",
"author": "Copyleaks ltd",
"author_email": "sales@copyleaks.com",
"download_url": "https://files.pythonhosted.org/packages/0d/8c/8c23a750a980cd74cc35dbb2883bb82794d92fa807f101c0d12080f2a478/copyleaks-4.2.1.tar.gz",
"platform": null,
"description": "## Copyleaks Python SDK\n\nCopyleaks SDK is a simple framework that allows you to scan textual content for plagiarism and trace content distribution online, using the [Copyleaks plagiarism checker cloud](https://api.copyleaks.com).\n\nDetect plagiarism using Copyleaks SDK in:\n\n* Online content and webpages\n* Local and cloud files ([see supported files](https://api.copyleaks.com/GeneralDocumentation/TechnicalSpecifications#supportedfiletypes\"))\n* Free text\n* OCR (Optical Character Recognition) - scanning pictures with textual content ([see supported files](https://api.copyleaks.com/GeneralDocumentation/TechnicalSpecifications#supportedfiletypes))\n\n### Installation\n\nSupported Python version: 3.\n\nYou have two ways to integrate with the Copyleaks SDK:\n\n* **Recommended** - Use the Python Package Manager - [PiPy](https://pypi.python.org/pypi/copyleaks). \n When integrating this way you will automatically be able to update the SDK to its latest version:\n\n <pre>pip3 install copyleaks\n </pre>\n\n* Download the code from this repository and add it to your project.\n\n### Register and Get Your API Key\n\nTo use the Copyleaks SDK you need to have a Copyleaks account. The registration to Copyleaks is free of charge and quick. [Sign up](https://api.copyleaks.com/?register=true) and confirm your account to finalize your registration.\n\nNow, generate your personal API key on your [dashboard](https://api.copyleaks.com/dashboard) under 'API Access Credentials'.\n\nFor more information check out our [API guide](https://api.copyleaks.com/documentation/v3).\n\n### Examples\n\nSee the [example.py](https://github.com/Copyleaks/Python-Plagiarism-Checker/blob/master/example.py) file.\n\n* To change the Identity server URI (default:\"https://id.copyleaks.com\"):\n\n<pre>Copyleaks.set_identity_uri(\"your identity server uri\");\n</pre>\n\n* To change the API server URI (default:\"https://api.copyleaks.com\"):\n\n<pre>Copyleaks.set_api_uri(\"your api server uri\");\n</pre>\n\n### Dependencies\n\n<pre>pip3 install requests pytz python-dateutil\n</pre>\n\n### Read More\n\n* [API Homepage](https://api.copyleaks.com)\n* [API Documentation](https://api.copyleaks.com/documentation)\n* [Plagiarism Report](https://github.com/Copyleaks/plagiarism-report)",
"bugtrack_url": null,
"license": null,
"summary": "Copyleaks API gives you access to a variety of plagiarism detection technologies to protect your online content. Get the most comprehensive plagiarism report for your content that is easy to use and integrate.",
"version": "4.2.1",
"project_urls": {
"Download": "https://github.com/Copyleaks/Python-Plagiarism-Checker",
"Homepage": "https://api.copyleaks.com"
},
"split_keywords": [
"copyleaks",
" api",
" plagiarism",
" content",
" checker",
" online",
" academic",
" publishers",
" websites"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d8c8c23a750a980cd74cc35dbb2883bb82794d92fa807f101c0d12080f2a478",
"md5": "a4db18a8e8b297c3966c6f2f683407ba",
"sha256": "2d5503cc8b0a7f96daa1979a71c9de8fb7be9b7dc9d07cf41f77ca2c7568bd1d"
},
"downloads": -1,
"filename": "copyleaks-4.2.1.tar.gz",
"has_sig": false,
"md5_digest": "a4db18a8e8b297c3966c6f2f683407ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16425,
"upload_time": "2025-01-09T12:27:24",
"upload_time_iso_8601": "2025-01-09T12:27:24.209232Z",
"url": "https://files.pythonhosted.org/packages/0d/8c/8c23a750a980cd74cc35dbb2883bb82794d92fa807f101c0d12080f2a478/copyleaks-4.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 12:27:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Copyleaks",
"github_project": "Python-Plagiarism-Checker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "copyleaks"
}
JSON
