update to internal commit a71bd083

_config.yml

@@ -12,6 +12,10 @@ dcp_dotnet: /code-parser/docs/server/programming/dotnet/
 dcp_dotnet_api: /code-parser/docs/server/programming/dotnet/api-reference/
 dcp_dotnet_release_notes: /code-parser/docs/server/programming/dotnet/release-notes/
 
+dcp_python: /code-parser/docs/server/programming/python/
+dcp_python_api: /code-parser/docs/server/programming/python/api-reference/
+dcp_python_release_notes: /code-parser/docs/server/programming/python/release-notes/
+
 assets: /code-parser/docs/server/assets/
 edit_icon: /code-parser/docs/server/assets/img-icon/edit-icon.png
 smile_icon: /code-parser/docs/server/assets/img-icon/icon-smile.png
@@ -25,8 +29,10 @@ dcv_enumerations: /capture-vision/docs/core/enums/
 dcv_parameters: /capture-vision/docs/core/parameters/
 dcv_cpp_api: /capture-vision/docs/server/programming/cplusplus/api-reference/
 dcv_dotnet_api: /capture-vision/docs/server/programming/dotnet/api-reference/
+dcv_python_api: /capture-vision/docs/server/programming/python/api-reference/
 
-useVersionTree: true
+useVersionTree: false
+isDCV: true
 
 baseurl: "/code-parser/docs/server"
 plugins:
@@ -53,6 +59,16 @@ defaults:
     values: 
       docRootName: "Code Parser C++ Edition" 
       docHomePage: "/code-parser/docs/server/programming/cplusplus/"
+  - scope: 
+      path: "programming/dotnet" 
+    values: 
+      docRootName: "Code Parser .NET Edition" 
+      docHomePage: "/code-parser/docs/server/programming/dotnet/"
+  - scope: 
+      path: "programming/python" 
+    values: 
+      docRootName: "Code Parser Python Edition" 
+      docHomePage: "/code-parser/docs/server/programming/python/"
   - scope:
       path: "Hide_Tree_Page.html"
     values:

_data/full_tree.yml

@@ -2,3 +2,4 @@ tree_file_list:
     - sidelist-full-tree.html
     - sidelist-programming/programming-cpp.html
     - sidelist-programming/programming-dotnet.html
+    - sidelist-programming/programming-python.html

_includes/release-notes/python-highlight-2.4.10.md

@@ -0,0 +1,14 @@
+
+* This is the first release of the Python Edition of `DynamsoftCodeParser` SDK integrated with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually.
+* Added supports to parse following code types:
+  * [MRTD_TD1_ID]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD2_ID]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD2_VISA]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD3_PASSPORT]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD3_VISA]({{ site.dcp_code_types }}mrtd.html)
+  * [VIN]({{ site.dcp_code_types }}vin.html)
+  * [AAMVA_DL_ID]({{ site.dcp_code_types }}aamva-dl-id.html)
+  * [AAMVA_DL_ID_WITH_MAG_STRIPE]({{ site.dcp_code_types }}aamva-dl-id.html)
+  * [AADHAAR]({{ site.dcp_code_types }}aadhaar.html)
+  * [SOUTH_AFRICA_DL]({{ site.dcp_code_types }}za-dl.html)
+

_includes/sidelist-full-tree.html

@@ -1,8 +1,8 @@
-<!--
 <li lang="python">
-    <a href="{{ site.python }}" class="otherLinkColour">Python Edition Introduction</a>
+    <a href="{{ site.dcp_python }}" class="otherLinkColour">Python Edition Introduction</a>
 </li>
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-python.html" -%}
+<!--
 <li lang="java">
     <a href="{{ site.java }}" class="otherLinkColour">Java Edition Introduction</a>
 </li>

_includes/sidelist-programming/programming-dotnet.html

@@ -1,5 +1,5 @@
 <li lang="dotnet" class="category">DEVELOPMENT</li>
-<li lang="dotnet"><a class="otherLinkColour">API Reference</a>
+<li lang="dotnet"><a href="{{ site.dcp_dotnet_api }}" class="otherLinkColour">API Reference</a>
     <ul>
         <li><a class="otherLinkColour">Classes</a>
             <ul>

_includes/sidelist-programming/programming-python.html

@@ -0,0 +1,24 @@
+<li lang="python" class="category">DEVELOPMENT</li>
+<li lang="python"><a href="{{ site.dcp_python_api }}" class="otherLinkColour">API Reference</a>
+    <ul>
+        <li><a class="otherLinkColour">Classes</a>
+            <ul>
+                <li><a href="{{ site.dcp_python_api }}code-parser-module.html"  class="otherLinkColour">CodeParserModule</a></li>
+                <li><a href="{{ site.dcp_python_api }}parsed-result.html"  class="otherLinkColour">ParsedResult</a></li>
+                <li><a href="{{ site.dcp_python_api }}parsed-result-item.html"  class="otherLinkColour">ParsedResultItem</a></li>
+            </ul>
+        </li>
+        <li><a class="otherLinkColour">Enumerations</a>
+            <ul>
+                <li><a href="{{ site.dcv_enumerations }}core/error-code.html?lang=python"  class="otherLinkColour">EnumErrorCode</a></li>
+                <li><a href="{{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python"  class="otherLinkColour">EnumMappingStatus</a></li>
+                <li><a href="{{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python"  class="otherLinkColour">EnumValidationStatus</a></li>
+            </ul>
+        </li>
+    </ul>
+</li>
+<li lang="python"><a href="{{ site.dcp_python_release_notes }}" class="otherLinkColour">Release Notes</a>
+    <ul >
+        <li ><a href="{{ site.dcp_python_release_notes }}python-2.html" class="otherLinkColour">Version 2.x</a></li>
+    </ul>
+</li>

assets/js/dcpServerVersionSearch.json

@@ -87,6 +87,92 @@
                         "version": "3.4.10"
                     }
                 ]
+            },
+            "python":{
+                "dcvRepoServer": [
+                    {
+                        "path": "/programming/python/api-reference/capture-vision-router",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/core",
+                        "version": "3.2.40"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/image-processing",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/license",
+                        "version": "3.2.30"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/utility",
+                        "version": "1.4.10"
+                    }
+                ],
+                "dcvRepoCore": [
+                    {
+                        "path": "/enums/capture-vision-router",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/enums/code-parser",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/enums/core",
+                        "version": "3.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/barcode-format-specification",
+                        "version": "10.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/barcode-reader-task-settings",
+                        "version": "10.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/capture-vision-template",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/character-model",
+                        "version": "3.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/code-parser-task-settings",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/global-parameter",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/image-parameter",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/image-source-options",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/label-recognizer-task-settings",
+                        "version": "3.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/semantic-processing",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/target-roi-def",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/text-line-specification",
+                        "version": "3.4.10"
+                    }
+                ]
             }
         }
     },

index.md

@@ -1,7 +1,7 @@
 ---
 layout: home-page
 title: Dynamsoft Code Parser SDK Documentation
-keywords: Dynamsoft Code Parser, dlr, documentation
+keywords: Dynamsoft Code Parser, documentation
 description: Dynamsoft Code Parser SDK Documentation Homepage
 ---
 
@@ -11,9 +11,9 @@ Learn how to use Dynamsoft Code Parser SDK in different programming languages:
 
 - [C++]({{ site.dcp_cpp }})
 - [.NET]({{ site.dcp_dotnet }})
+- [Python]({{ site.dcp_python }})
 
 Coming soon:
 
-- Python
 - C
 - Java

programming/python/api-reference/code-parser-module.md

@@ -0,0 +1,41 @@
+---
+layout: default-layout
+title: CodeParserModule Class - Dynamsoft Code Parser Module Python Edition API Reference
+description: Definition of the CodeParserModule class in Dynamsoft Code Parser Module Python Edition.
+keywords: CodeParserModule, api reference, python
+needAutoGenerateSidebar: true
+---
+
+# CodeParserModule Class
+
+The `CodeParserModule` class defines general functions in the code parser module.
+
+## Definition
+
+*Module:* dynamsoft_code_parser
+
+
+```python
+class CodeParserModule(object)
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`get_version`](#get_version) | Returns the version of the code parser module.|
+
+
+### get_version
+
+Returns the version of the code parser module.
+
+```python
+@staticmethod
+def get_version() -> str:
+```
+
+**Return Value**
+
+Returns a string representing the version of the code parser module.
+

programming/python/api-reference/index.md

@@ -0,0 +1,22 @@
+---
+layout: default-layout
+title: Main Page - Dynamsoft Code Parser Module Python Edition API Reference
+description: This is the main page of Dynamsoft Code Parser SDK Python Edition API Reference.
+keywords: api reference, python
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+---
+
+# API Reference - Dynamsoft Code Parser SDK Python Edition
+
+## Classes
+
+* [`CodeParserModule`]({{ site.dcp_python_api }}code-parser-module.html)
+* [`ParsedResult`]({{ site.dcp_python_api }}parsed-result.html)
+* [`ParsedResultItem`]({{ site.dcp_python_api }}parsed-result-item.html)
+
+## Enumerations  
+
+* [`EnumErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=python)
+* [`EnumMappingStatus`]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python)
+* [`EnumValiadtionStatus`]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python)

programming/python/api-reference/parsed-result-item.md

@@ -0,0 +1,113 @@
+---
+layout: default-layout
+title: ParsedResultItem Class - Dynamsoft Code Parser Module Python Edition API Reference
+description: Definition of the ParsedResultItem class in Dynamsoft Code Parser Module Python Edition.
+keywords: ParsedResultItem, api reference, python
+needAutoGenerateSidebar: true
+---
+
+# ParsedResultItem Class
+
+The `ParsedResultItem` class represents a parsed result item generated by code parser engine.
+
+## Definition
+
+*Module:* dynamsoft_code_parser
+
+*Inheritance:* [CapturedResultItem]({{ site.dcv_python_api }}core/basic-classes/captured-result-item.html) -> ParsedResultItem
+
+```python
+class ParsedResultItem(dynamsoft_core.CapturedResultItem)
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`get_code_type`](#get_code_type) | Gets the code type of the parsed result. |
+| [`get_field_value`](#get_field_value) | Gets the value of a specified field from the parsed result. |
+| [`get_field_mapping_status`](#get_field_mapping_status) | Gets the mapping status of a specified field from the parsed result. |
+| [`get_field_validation_status`](#get_field_validation_status) | Gets the validation status of a specified field from the parsed result. |
+| [`get_json_string`](#get_json_string) | Gets the parsed result as a JSON formatted string. |
+
+### get_code_type
+
+Gets the code type of the parsed result.
+
+```python
+def get_code_type(self) -> str:
+```
+
+**Return Value**
+
+Returns a string value representing the code type.
+
+### get_field_value
+
+Gets the value of a specified field from the parsed result.
+
+```python
+def get_field_value(self, field_name: str) -> str:
+```
+
+**Parameters**
+
+`field_name` The name of the field.
+
+**Return Value**
+
+Returns a string representing the specified field value.
+
+### get_field_mapping_status
+
+Gets the mapping status of a specified field from the parsed result.
+
+```python
+def get_field_mapping_status(self, field_name: str) -> int:
+```
+
+**Parameters**
+
+`field_name` The name of the field.
+
+
+**Return Value**
+
+Returns an `EnumMappingStatus` value representing the mapping status of a specified field.
+
+**See Also**
+
+[EnumMappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python)
+
+### get_field_validation_status
+
+Gets the validation status of a specified field from the parsed result.
+
+```python
+def get_field_validation_status(self, field_name: str) -> int:
+```
+
+**Parameters**
+
+`field_name` The name of the field.
+
+**Return Value**
+
+Returns an `EnumValidationStatus` value representing the validation status of a specified field.
+
+**See Also**
+
+[EnumValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python)
+
+### get_json_string
+
+Gets the parsed result as a JSON formatted string.
+
+```python
+def get_json_string(self) -> str:
+```
+
+**Return Value**
+
+Returns a JSON formatted string representing the full parsed result.
+