Licensing and Evaluation Leave feedback

This guide explains the different licensing options available for GroupDocs.Total for Python via .NET and how to properly set up licensing in your applications.

GroupDocs offers multiple licensing options to suit your needs:

• Free Trial (for evaluation)
• 30-day Temporary License
• Purchased License
• Metered License (pay-as-you-go)

Note

For detailed information about our licensing policies and frequently asked questions, please visit the Purchase Policies and FAQ section.

The evaluation version is identical to the purchased version and becomes fully licensed once a valid license is applied. However, it includes the following limitations:

• Evaluation watermark on output documents
• Page processing limits (vary by product)
• Other product-specific limitations

For testing without trial limitations, you can request a 30-day Temporary License:

1. Visit the Get a Temporary License page
2. Follow the on-screen instructions to request your temporary license
3. Apply the license using one of the methods described below

• Each product is licensed separately: apply the license in every product your application uses, either with that product’s License class or once for all of them with the GROUPDOCS_LIC_PATH environment variable (method 3 below)
• Set the license only once per product
• Set the license before using any GroupDocs.Total code
• Multiple calls to set_license are safe but unnecessary
• Avoid multiple calls to set_metered_key, as this may interfere with accurate consumption tracking.

You can apply the license using a file path or a stream.

Note

The following code examples show how to set license for GroupDocs.Conversion API but the process is the same for all of the APIs included into GroupDocs.Total.

The following code demonstrates setting a license from a file:

import os
from groupdocs.conversion import License

def set_license_from_file():
    # Get absolute path to license file
    license_path = os.path.abspath("./GroupDocs.Total.lic")

    if os.path.exists(license_path):
        # Instantiate License and set the license
        license = License()
        license.set_license(license_path)
    else:
        print("License file not found. Running in evaluation mode.")

if __name__ == "__main__":
    set_license_from_file()

This example shows how to set a license from a stream:

import os
from groupdocs.conversion import License

def set_license_from_stream():
    # Get absolute path to license file
    license_path = os.path.abspath("./GroupDocs.Total.lic")

    if not os.path.exists(license_path):
        print("License file not found. Running in evaluation mode.")
        return

    # Create a readable stream
    with open(license_path, "rb") as license_stream:
        # Instantiate and set the license
        license = License()
        license.set_license(license_stream)

if __name__ == "__main__":
    set_license_from_stream()

Set GROUPDOCS_LIC_PATH to the path of the license file, or to a URL that serves it, and every product applies the license by itself at its first call, with no license code in your application. A license URL is downloaded once and cached.

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

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

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

The following sample demonstrates how to use metered licensing:

from groupdocs.conversion import Metered

def set_metered_license():
    # Set your public and private keys
    public_key = "******" 
    private_key = "******" 

    # Instantiate Metered and set keys
    metered = Metered()
    metered.set_metered_key(public_key, private_key)

    # Get the number of MBs processed
    mb_processed = metered.get_consumption_quantity()
    print("MB processed: ", mb_processed)

    # Get the number of credits used
    credits_used = metered.get_consumption_credit()
    print("Credits used: ", credits_used)

if __name__ == "__main__":
    set_metered_license()

• You can rename the license file as needed
• Ensure the filename in your code matches the actual file name

If you’re setting a license file using a relative path and encountering issues, try using the absolute file path instead.