[EPIC-6378] Prepare/restructure for stable RC #19

yurii-scanbot · 2025-08-18T16:04:06Z

No description provided.

… sync across Java/Python/C wrappers

examples/c/src/snippets/license/floating_license.c

examples/c/src/snippets/document/crop_and_analyse.c

examples/c/src/snippets/document/detect_document.c

examples/c/src/snippets/datacapture/ocr.c

examples/c/src/snippets/document/document_classifier.c

examples/c/src/snippets/datacapture/credit_card_scanner.c

examples/c/src/utils/utils.c

examples/c/src/main.c

Add snippets for nodejs wrapper

…eate configs

… commens and separated functions

…s for scanner/result/etc.

examples/c/src/main.c

examples/c/src/snippets/datacapture/ocr.c

examples/c/src/snippets/document/analyse_multi_page.c

examples/c/src/snippets/live/live_barcode.c

examples/c/src/snippets/datacapture/medical_certificate_scanner.c

examples/c/src/main.c

examples/java/src/main/java/io/scanbot/sdk/snippets/barcode/DetectBarcodesSnippet.java

examples/java/src/main/java/io/scanbot/sdk/snippets/datacapture/CheckScannerSnippet.java

examples/java/src/main/java/io/scanbot/sdk/snippets/datacapture/CreditCardScannerSnippet.java

examples/java/src/main/java/io/scanbot/sdk/snippets/license/FloatingLicenseSnippet.java

examples/java/src/main/java/io/scanbot/sdk/utils/Utils.java

examples/java/src/main/java/io/scanbot/sdk/ScanbotSDKExample.java

…d encodeImages comments

examples/python/minimal/snippets/barcode/detect_barcodes.py

examples/python/minimal/snippets/datacapture/check.py

examples/python/minimal/snippets/barcode/barcode_document_parser.py

examples/python/minimal/snippets/datacapture/check.py

examples/python/minimal/snippets/document/analyse_multi_page.py

examples/python/minimal/snippets/document/crop_and_analyse.py

examples/python/minimal/snippets/live/barcode_live.py

examples/python/minimal/main.py

examples/nodejs/src/index.ts

examples/nodejs/src/snippets/barcode/detect-barcodes.ts

examples/nodejs/README.md

examples/nodejs/package.json

examples/nodejs/src/snippets/datacapture/ocr.ts

examples/nodejs/src/snippets/datacapture/text-pattern-scanner.ts

examples/nodejs/src/snippets/utils/utils.ts

examples/python/README.md

examples/java/README.md

cyrillicw · 2025-09-12T07:33:27Z

examples/nodejs/README.md

+
+### Install the Scanbot SDK
+Replace `<SCANBOT_SDK_VERSION>` with the actual version number of the SDK you want to install.
+  ```bash


Usually in examples we do this like

export SCANBOT_SDK_VERSION=<SCANBOT_SDK_VERSION> npm install https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv$SCANBOT_SDK_VERSION/nodejs-scanbotsdk-$SCANBOT_SDK_VERSION.tgz

So that you have to replace the version only in one place.

replaced with export SCANBOT_SDK_VERSION=<SCANBOT_SDK_VERSION>

cyrillicw · 2025-09-12T07:34:50Z

examples/nodejs/package.json

+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "scanbotsdk": "https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv0.800.3/nodejs-scanbotsdk-0.800.3.tgz"


If you specify url here, then there is no need to install package manually as it is specified in the readme

agreed to completely remove url from dependencies

cyrillicw · 2025-09-12T07:36:56Z

examples/nodejs/src/snippets/document/analyse-multipage.ts

+
+      if (images && images.length > 0) {
+        for (let imageIndex = 0; imageIndex < images.length; imageIndex++) {
+          const extractedImage = images[imageIndex]?.image;


There is no explanation why this inner await using is needed. In java examples we explain that the images are initially stored in a compressed way and we do this in order to prevent a lot of decompressed images to be stored in memory

cyrillicw · 2025-09-12T07:37:55Z

examples/nodejs/src/snippets/image/image-processing.ts

+export async function applyBinarizationFilter(image: ScanbotSDK.ImageRef, path: string): Promise<void> {
+  await using imageProcessor = await ScanbotSDK.ImageProcessor.create();
+  const filter = new ScanbotSDK.CustomBinarizationFilter({ preset: "PRESET_4" });
+  await using filtered_img = await imageProcessor.applyFilter(image, filter);


filteredImg

cyrillicw · 2025-09-12T07:40:38Z

examples/python/README.md

+Replace `<SCANBOT_SDK_VERSION>` with the actual version number of the SDK you want to install.
+* **On ARM64 (Raspberry Pi, Jetson Nano, etc.):**
+  ```bash
+  pip install https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv<SCANBOT_SDK_VERSION>/scanbotsdk-<SCANBOT_SDK_VERSION>-py3-none-linux_aarch64.whl


In the old example we had

export SCANBOT_SDK_VERSION=<SCANBOT_SDK_VERSION>

and then used this variable in installation scripts, it allows to specify this version only once. Relates to all the readmes

replaced with export SCANBOT_SDK_VERSION=<SCANBOT_SDK_VERSION>

cyrillicw · 2025-09-12T07:42:21Z

examples/java/build.gradle

 }

-// TODO Add your SCANBOTSDK_API_TOKEN and SCANBOTSDK_VERSION here.
-// They are available on request via [email protected]


They are available on request via [email protected]

Probably no need to remove this line

removed [email protected] in all places

cyrillicw · 2025-09-16T13:06:56Z

examples/python/snippets/document/analyse_multi_page.py

+    )
+    # Configure other parameters as needed.
+
+    file_access_source = RandomAccessSource(file_path=file_path)


Better to do like this:
with RandomAccessSource(file_path=file_path) as file_access_source: ...
The file will in any case be automatically closed when the variable goes out of scope (as we override __del__ for the class but standard practise in python when dealing with files to use context managers and for this we also implement context manager functions for the class

Kyrylo and others added 10 commits August 6, 2025 11:17

C Wrapper Barcode Live Example

2bda812

Use goto in c wrapper example

6086e0d

Readme files c wrapper

51420c7

Add tensorrt support

649cd88

Improve FindScanbotSDK.cmake

a13b192

refactor structure of java example. added new snippets

e021d63

refactor structure of python example

be1b02b

merge c wrapper example

4ae7a0a

fixed merge conflics c barcode examples

ed2aceb

restructure project and add scan/analyze/classify/parse snippets with…

a4573e2

… sync across Java/Python/C wrappers

yurii-scanbot changed the title ~~Prepare for stable RC~~ Prepare/restructure for stable RC Aug 18, 2025

yurii-scanbot requested review from cyrillicw and tailsu August 18, 2025 16:08

cyrillicw requested changes Aug 19, 2025

View reviewed changes

cyrillicw requested changes Aug 20, 2025

View reviewed changes

yurii-scanbot and others added 9 commits August 21, 2025 12:10

add snippets for nodejs wrapper

b88612a

Merge pull request #20 from doo/yk/snippets_nodejs

5afb93a

Add snippets for nodejs wrapper

replace magic constants

9aed4c2

remove function declarations from headers that aren't in use

14765af

refactor main.c, for early outs always goto cleanup

a155f75

refactor snippets cleanups and unnecessary condition under default cr…

984e928

…eate configs

refactored analyse sumcommand and floatin license snippets with clear…

01939df

… commens and separated functions

added optional param for --license in cli

c129240

updated nodejs snippets with better way to dispose unmanaged resource…

fbc934d

…s for scanner/result/etc.

yurii-scanbot requested a review from cyrillicw August 22, 2025 11:55

yurii-scanbot added 3 commits August 22, 2025 14:05

added --license key flag from cli to java and python examples

cd6045b

rename mrz parser snippet java

70ca861

separate live scanners snippets

308eaea

cyrillicw requested changes Aug 26, 2025

View reviewed changes

yurii-scanbot changed the title ~~Prepare/restructure for stable RC~~ [EPIC-6378] Prepare/restructure for stable RC Aug 26, 2025

yurii-scanbot added 3 commits August 26, 2025 16:46

refactor java snippets, improve comments

5c8bd8b

removed unnecessary license checks inside of code snippets and remove…

499dcc4

…d encodeImages comments

prepare image processing snippets

da1269d

cyrillicw requested changes Sep 2, 2025

View reviewed changes

awaitPromise function in nodejs example

db25ae7

cyrillicw requested changes Sep 2, 2025

View reviewed changes

examples/nodejs/src/index.ts Show resolved Hide resolved

cyrillicw requested changes Sep 2, 2025

View reviewed changes

examples/nodejs/src/snippets/barcode/detect-barcodes.ts Outdated Show resolved Hide resolved

yurii-scanbot added 4 commits September 2, 2025 18:09

python wrapper snippets refactoring

bf2780c

add missing frame_callback in live example

c894030

revert back description under from_ndarray on_frame

975be33

update readme python example

c51202d

yurii-scanbot marked this pull request as ready for review September 3, 2025 11:15

yurii-scanbot added 3 commits September 3, 2025 13:21

removed release tag from readme manual python

76ef3d5

add nodejs readme guid

b001d78

update readme for node/java/python

5238d32

cyrillicw requested changes Sep 10, 2025

View reviewed changes

yurii-scanbot added 5 commits September 11, 2025 14:51

node wrapper refactoring. split print result for barcode scanners

3732884

updated python example structure

d2c9cce

replaced int status with meaningful string for all cases in C examples

d4fb60d

update image processing snippets

3548e81

update readmes with esage and example

e8be748

yurii-scanbot requested a review from cyrillicw September 11, 2025 14:44

cyrillicw requested changes Sep 12, 2025

View reviewed changes

yurii-scanbot added 3 commits September 12, 2025 11:21

refactor live python example and add in addition document scanner

3402634

refactor readme's version exports and minor comment updates

5d9e96f

fixed live python examples

aa8c857

yurii-scanbot requested a review from cyrillicw September 12, 2025 11:29

cyrillicw requested changes Sep 16, 2025

View reviewed changes

[EPIC-6378] Prepare/restructure for stable RC #19

Are you sure you want to change the base?

[EPIC-6378] Prepare/restructure for stable RC #19

Uh oh!

Conversation

yurii-scanbot commented Aug 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment