This repository contains the Celantur SDK Library, which provides a comprehensive set of tools and functionalities for developers to integrate Celantur's capabilities into their applications. To get started, please refer to the Celantur SDK Installation guide. To get some examples of how to use it, refer to examples.

Overview

SDK consists of two modules: SDK Module and Common module. SDK Module contains the main classes and functions to work with the Celantur SDK and contains classes that are required to perform anonymisation. It has a distinct namespace of CelanturSDK.

The Common module provides interoperability between user-facing classes of SDK Module module and internal implementation and as such, it provides classes, enums and interfaces that are used both by SDK Module and by the internal implementation. It has a namespace of celantur. The Common module is further split into submodules that are sorted according to different problems they solve.

Build

To build a software that will use Celantur SDK, the easiest way is to use CMake. If you installed celantur SDK to the default location(/usr/local/), you can use the following commands to configure your project

cmake -S /your/src/dir -B /your/build/dir -DCppProcessing_DIR=/usr/local/lib/cmake

To find the modules in your CMakeLists.txt, you can use the following command:

find_package(CppProcessing REQUIRED CelanturSDK common-module)

Finally, to actually link the libraries to your executable or library, you can use the following command:

target_link_libraries(YourExecutableOrLibrary PRIVATE CppProcessing::CelanturSDK CppProcessing::common-module)