Skip to main content

A Python SDK for Copyleaks (http://copyleaks.com)

Project description

Copyleaks (http://www.copyleaks.com) Python SDK

Installing dependencies

Create a virtual environment and install dependencies from requirements.txt by running (from the root):

> pip install -r requirements.txt

Setup

You can setup the project by downloading the source code and then running the following command:

> python setup.py install

Once installed you should get your API key from http://copyleaks.com and you can get started. For example, here is how you can count credits

>>> from copyleaks_sdk.copyleaks import CopyLeaks
>>> self.copyleak = CopyLeaks(YOUR USERNAME HERE, API KEY HERE)
>>>
>>> def test_count_credits(self):
>>>     credit = self.copyleak.count_credits()

And here is how you can create a process by file:

>>> response = self.copyleak.create_process_by_file('full_path_of_file.txt')

There are tests available, kindly look at them for some example code.

Tests

Firstly, in order for tests to run you need a config.py under tests directory containing API credentials. For example, we will have a file tests/config.py with following contents:

username = 'USERNAME HERE'
api_key = 'API KEY GOES HERE'

You can find tests under copyleaks-python-sdk/tests. Tests are written the built-in unittest module and can simply be run from the command line.

License

This project is licensed under the terms of MIT license.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

CopyleaksPythonSDK-0.1.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file CopyleaksPythonSDK-0.1.tar.gz.

File metadata

File hashes

Hashes for CopyleaksPythonSDK-0.1.tar.gz
Algorithm Hash digest
SHA256 deadce3c116c3873391a28e0a39b4073ea62ccc215b9fa559c3bc1ef403a2b45
MD5 cd33f3fcef145c7c85ca972c42b16ee4
BLAKE2b-256 962d4fbdf70adb05bd3911ff6df27b846cdbfdfb2ef41bbfadf6d3fbfb46c3e2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page