Installation Guide

Integrating the Inscoper API into your development environment is a straightforward process. The API is distributed as a native C++ core with high-level bindings for Java and Python.

C++ Integration

The C++ API is distributed as a set of headers and a shared library (DLL).

1. Headers: Include the InscoperAPI/API directory in your project's include paths.
2. Library: Link your application against inscoper_api.lib.
3. Runtime: Ensure inscoper_api.dll is present in your executable's directory or within your system's PATH.

Architecture Match

Always match the architecture (x64) of your application with the Inscoper API library.

Java Integration

The Java bindings are distributed as a single, self-contained JAR file that includes the necessary native binaries for Windows.

1. Dependency: Add inscoper_api.jar to your project's classpath.
2. Native Loading: The JAR handles the extraction and loading of the native library (inscoper_api_java.dll) automatically. No manual DLL placement is required.

Permissions

Since the native library is embedded, ensure your JVM has write permissions for its temporary directory to allow for library extraction.

Python Integration

The Python API is distributed as a Wheel file (.whl) for easy installation via pip.

1. Installation: Run the following command in your terminal or virtual environment:

   pip install inscoper_api-*.whl
   

2. Verification: Check the installation by importing the module:

   import inscoper
   print(inscoper.get_version())
   

Native Binaries

The Python Wheel contains the necessary native binaries. No additional DLL manual placement is required for Python.