Evaluation Limitations and Licensing Leave feedback

To help you explore the library quickly, GroupDocs.Signature offers a Free Trial and a 30-day Temporary License for evaluation, along with various purchase plans.

Note

General policies and practices for evaluating, licensing, and purchasing our products are described in the Purchase Policies and FAQ section.

You can try GroupDocs.Signature without purchasing a license.

The evaluation version is the same package as the licensed one: it becomes fully licensed when you apply a license, as described below. Without a license, the following limitations apply:

To test GroupDocs.Signature without these limitations, request a 30-day Temporary License. For more information, see the Get a Temporary License page.

Note

For information on pricing, visit the Pricing Information page.

Once you have a license, apply it in one of the ways below. A license should be set:

• only once per application, and
• before you use any other GroupDocs.Signature class.

Tip

The license can be set more than once per application, but set it only once: each set_license call takes processing time.

Set the GROUPDOCS_LIC_PATH environment variable to the full path of the license file. The license is then applied automatically when groupdocs.signature is imported, and your code needs no license call at all. The variable may also hold an HTTPS URL: the license is downloaded once and cached in the system’s temporary folder.

set GROUPDOCS_LIC_PATH=C:\path\to\GroupDocs.Signature.lic

$env:GROUPDOCS_LIC_PATH = "C:\path\to\GroupDocs.Signature.lic"

export GROUPDOCS_LIC_PATH="/path/to/GroupDocs.Signature.lic"

export GROUPDOCS_LIC_PATH="/path/to/GroupDocs.Signature.lic"

Warning

A missing or unreadable file in GROUPDOCS_LIC_PATH does not raise an error, because a license problem must not break the import. The library then runs in evaluation mode. If outputs still carry the evaluation line, check the path.

The following code sets a license from a file:

import os

from groupdocs.signature import License


def set_license_from_file():
    # The license file next to the script; change the name to match yours
    license_path = os.path.abspath("GroupDocs.Signature.lic")
    if os.path.exists(license_path):
        # Apply the license once, before using any other GroupDocs.Signature API
        License().set_license(license_path)
        print("License set successfully.")
    else:
        print("License file not found; running in evaluation mode.")


if __name__ == "__main__":
    set_license_from_file()

Warning

set_license raises GroupDocsSignatureException (“License file not found”) when the file does not exist. It does not validate the file’s contents, though: a damaged or wrong license file is accepted without an error, and the library stays in evaluation mode. To confirm that a license works, sign a test document and check that no evaluation line appears on its pages.

set_license also accepts a readable binary stream, such as an open file or an io.BytesIO holding the license bytes:

import os

from groupdocs.signature import License


def set_license_from_stream():
    license_path = os.path.abspath("GroupDocs.Signature.lic")
    if os.path.exists(license_path):
        with open(license_path, "rb") as stream:
            License().set_license(stream)
        print("License set successfully.")
    else:
        print("License file not found; running in evaluation mode.")


if __name__ == "__main__":
    set_license_from_stream()

A Metered License is an alternative to a license file. It is a usage-based licensing model that may suit customers who prefer to be billed for actual API usage. For more information, refer to the Metered Licensing FAQ.

To use it:

1. Create an instance of the Metered class.
2. Pass your public and private keys to the set_metered_key method.
3. Process your documents.
4. Call Metered.get_consumption_quantity() to get the amount of data processed so far, in megabytes.
5. Call Metered.get_consumption_credit() to get the number of credits consumed so far.

from groupdocs.signature import Metered


def set_metered_license():
    public_key = "*****"  # Your public key
    private_key = "*****"  # Your private key

    # Skip the call while the placeholder keys are still in place
    if "*" in public_key or "*" in private_key:
        print("Provide your real metered keys to activate metered licensing.")
        return

    # Activate metered (pay-as-you-go) billing for this process
    Metered().set_metered_key(public_key, private_key)
    print("Metered license set successfully.")

    # ... process your documents here ...

    print(f"MB processed: {Metered.get_consumption_quantity()}")
    print(f"Credits used: {Metered.get_consumption_credit()}")


if __name__ == "__main__":
    set_metered_license()