Metadata-Version: 2.1
Name: amazon-textract-caller
Version: 0.0.10
Summary: Amazon Textract Caller tools
Home-page: https://github.com/aws-samples/amazon-textract-textractor
Author: Amazon Rekognition Textract Demoes
Author-email: rekognition-textract-demos@amazon.com
License: Apache License Version 2.0
Description: # Textract-Caller
        
        amazon-textract-caller provides a collection of ready to use functions and sample implementations to speed up the evaluation and development for any project using Amazon Textract.
        
        Making it easy to call Amazon Textract regardless of file type and location.
        
        ```
        def call_textract(input_document: Union[str, bytearray],
                          features: List[Textract_Features] = None,
                          output_config: OutputConfig = None,
                          kms_key_id: str = None,
                          job_tag: str = None,
                          notification_channel: NotificationChannel = None,
                          client_request_token: str = None,
                          return_job_id: bool = False,
                          force_async_api: bool = False) -> str:
        ```
        
        Also useful when receiving the JSON response from an asynchronous job (start_document_text_detection or start_document_analysis)
        
        ```
        def get_full_json(job_id: str = None,
                          textract_api: Textract_API = Textract_API.DETECT,
                          boto3_textract_client=None)->dict:
        ```
        
        And when receiving the JSON from the OutputConfig location, this is useful as well.
        ```
        def get_full_json_from_output_config(output_config: OutputConfig = None,
                                             job_id: str = None,
                                             s3_client = None)->dict:
        ```
        
        ## Samples
        
        ### Calling with file from local filesystem only with detect_text
        ```
        textract_json = call_textract(input_document="/folder/local-filesystem-file.png")
        ```
        
        ### Calling with file from local filesystem only detect_text and using in Textract Response Parser
        
        (needs trp dependency through```python -m pip install amazon-textract-response-parser```)
        ```
        import json
        from trp import Document
        from textracthelper.t_call call_textract
        
        textract_json = call_textract(input_document="/folder/local-filesystem-file.png")
        d = Document(json.loads(response))
        ```
        
        
        ### Calling with file from local filesystem with TABLES features
        
        ```
        from textracthelper.t_call call_textract, Textract_Features
        features = [Textract_Features.TABLES]
        response = call_textract(
            input_document="/folder/local-filesystem-file.png", features=features)
        ```
        
        ### Call with images located on S3 but force asynchronous API
        
        ```
        from textracthelper.t_call call_textract
        response = call_textract(input_document="s3://some-bucket/w2-example.png", force_async_api=True)
        ```
        
        ### Call with OutputConfig, Customer-Managed-Key
        
        ```
        from textracthelper.t_call call_textract
        from textractcaller.t_call import OutputConfig, Textract_Features
        output_config = OutputConfig(s3_bucket="somebucket-encrypted", s3_prefix="output/")
        response = call_textract(input_document="s3://someprefix/somefile.png",
                                  force_async_api=True,
                                  output_config=output_config,
                                  kms_key_id="arn:aws:kms:us-east-1:12345678901:key/some-key-id-ref-erence",
                                  return_job_id=False,
                                  job_tag="sometag",
                                  client_request_token="sometoken")
        
        ```
        
Keywords: amazon-textract-textractor amazon textract textractor helper caller
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
