.. _quick_start:

===============
Quick start
===============

Step 1 -- Request a license
===========================

To use the SDK, you need to get a license:

- Create an account on our customer portal: https://portal.id3.eu
- Make your request to our sales department: mailto:contact@id3.eu

Step 2 -- Download the SDK archive
==================================

1. Download the archive on our cloud drive (the link should provided by our sales department)
2. Uncompress the archive.

The SDK archive contains the following directories and files: 

::

    ├───activation                      # License activation tools for Windows, Linux and Jetson Nano
    │   ├───cli-tool
    │   └───windows-tool
    ├───bin                             # Native libraries
    │   ├───android
    │   ├───apple
    │   ├───linux
    │   └───windows
    ├───dart                            # Dart wrapper
    │   └───id3_bioseal
    ├───docs                            # API reference and Developer Guide
    │   ├───3rdparty
    │   ├───developer-guide
    │   └───javadoc
    ├───dotnet                          # .NET dynamic libraries
    ├───include                         # C header files
    ├───java                            # Java jar archives
    ├───python                          # Python package
    ├── CHANGELOG.md
    ├── LICENSE.md
    └── README.md

Step 3 -- Install the SDK
=========================

.. tab-set::

    .. tab-item:: Python
        :sync: Python

        Select the suitable wheel file for your platform and Python version, and run 

        .. code:: bash

            pip install id3bioseal-x.y.z-cp311-cp311-win_amd64.whl

        Then import it in your code:

        .. code:: python

            import id3bioseal
            print(f"Using BioSeal SDK version: {id3bioseal.__version__}")

    .. tab-item:: Dart
        :sync: Dart

        Add the dependency to your `pubspec.yaml`:

        .. code:: yaml

            dependencies:
              id3_bioseal: 
                path: ../../sdk/dart/id3_bioseal

        Then import it in your Dart code:

        .. code:: dart

            import 'package:id3_bioseal/id3_bioseal.dart';

    .. tab-item:: C#
        :sync: C#


        Install the NuGet package:

        .. code:: powershell

            Install-Package id3.Bioseal

        Then include the namespace:

        .. code:: csharp

            using id3.Bioseal;

    .. tab-item:: Java
        :sync: Java
   
        Add the Maven dependency to your `pom.xml`:

        .. code:: xml

            <dependency>
                <groupId>eu.id3</groupId>
                <artifactId>bioseal</artifactId>
                <version>1.0.0</version> <!-- Use the latest version -->
            </dependency>
        
        Then import the package:

        .. code:: java
        
            import eu.id3.bioseal.*;

    .. tab-item:: C
        :sync: C

        Include the header file in your project:

        .. code:: c

            #include "id3Bioseal.h"
            
            // Link against the appropriate library for your platform
            // - Windows: id3Bioseal.lib
            // - Linux: -lid3bioseal

Step 4 -- Run the samples
=========================

|product-name| contains sample projects for the following programming platforms and languages:

- Windows, Linux (C/C++)
- .NET (C#)
- Flutter (Dart)
- Android (Kotlin + Java)
- iOS (Swift)

.. note:: 
    | Those samples are not delivered in the ZIP archive.
    | They can be found directly here: https://github.com/id3Technologies/bioseal-sdk-samples

