Licensing Instructions

Standard (Royalty-Free) Licensing

In Windows, run the setup .exe file to install a license. No other actions are required.

In Linux and macOS visit the URL below to generate a Runtime License value.

https://www.nsoftware.com/full/IHTJA

After obtaining the RuntimeLicense value assign this to the RuntimeLicense property to license the application for deployment. For instance:

component.runtime_license = "<value from above>"

This provides a license to the component and your application will run without a license prompt on any machine to which it is distributed.

Note that each component instance in your code must be assigned a RuntimeLicense value.

Trial Licensing

In Windows, run the setup .exe file to install a license. No other actions are required.

In Linux and macOS visit the URL below to generate a 30-day Trial Runtime License value.

https://www.nsoftware.com/trial/IHTJA

After obtaining the RuntimeLicense value assign this to the RuntimeLicense property to license the application for deployment. For instance:

component.runtime_license = "<value from above>"

This provides a 30-day trial license to the component and your application will run without a license prompt on any machine to which it is distributed during that time.

Note that each component instance in your code must be assigned a RuntimeLicense value.

Single Machine Licensing

In Windows, run the setup .exe file to install a license. No other actions are required.

In Linux and macOS the install-license utility is used to activate a license. Download the install-license utility from http://www.nsoftware.com/lic/install-license.tar.gz and extract the archive. After extracting, run the install-license utility. For instance:

./install-license YOUR_PRODUCT_KEY -p IHTJA

The single machine license will be downloaded and stored in the ".nsoftware" folder of the user's home directory (i.e. "~/.nsoftware").

At runtime a valid license must be present in either the current directory or the ".nsoftware" folder of the user's home directory.

Deployment

After licensing your application using one of the above methods, no further steps are required to embed the license for distribution.

To deploy your application, simply ensure the module is installed on the deployment machine using pip: 

  cd C:\path\to\install_dir
  python -m pip install ipworksssh-24.0.xxxx.tar.gz

Once the product's Python package has been installed, the module can be imported and used: from ipworksssh import *. Nothing else is required to deploy the application.

As an alternative to installing the module using pip, you can manually deploy the application and module together. The module comes in two pieces, both of which must be deployed with the application.

  • The Python module named ipworksssh.py
  • The native library (unmanaged) named as follows:
    • Windows: pyipworksssh24.dll (available for x64 and x86 processor architectures)
    • Linux: libpyipworksssh.so.24.0 (available for x64 and x86 processor architectures)
    • macOS: libpyipworksssh24.0.dylib (available for x64 and ARM64 processor architectures)

Both pieces are included in the product's Python package, <install_dir>\ipworksssh-24.0.xxxx.tar.gz.

To package the module and native library alongside the application, first extract the archive then use the setuptools module to run the setup script setup.py. For instance: 

  cd C:\path\to\install_dir\ipworksssh-24.0.xxxx\
  python setup.py build --build-lib=<app_dir>

The above setup command packages the module and native library for deployment. A folder is created in the app_dir directory with the module and the native library packaged inside.

License Transfer

If you would like to transfer your license to another system, please complete our license transfer form. This will ensure your installations are not mistaken for license violations.

For additional information about our product activation process, please refer to our product activation FAQ.