Skip to main content

The client library for Aryn services

Project description

PyPI PyPI - Python Version Slack Docs License

aryn-sdk is a simple client library for interacting with Aryn cloud services.

Aryn DocParse

Partition pdf files with Aryn DocParse through aryn-sdk:

from aryn_sdk.partition import partition_file

with open("partition-me.pdf", "rb") as f:
    data = partition_file(
        f,
        use_ocr=True,
        extract_table_structure=True,
        extract_images=True
    )
elements = data['elements']

Convert a partitioned table element to a pandas dataframe for easier use:

from aryn_sdk.partition import partition_file, table_elem_to_dataframe

with open("partition-me.pdf", "rb") as f:
    data = partition_file(
        f,
        use_ocr=True,
        extract_table_structure=True,
        extract_images=True
    )

# Find the first table and convert it to a dataframe
df = None
for element in data['elements']:
    if element['type'] == 'table':
        df = table_elem_to_dataframe(element)
        break

Or convert all partitioned tables to pandas dataframes in one shot:

from aryn_sdk.partition import partition_file, tables_to_pandas

with open("partition-me.pdf", "rb") as f:
    data = partition_file(
        f,
        use_ocr=True,
        extract_table_structure=True,
        extract_images=True
    )
elements_and_tables = tables_to_pandas(data)
dataframes = [table for (element, table) in elements_and_tables if table is not None]

Visualize partitioned documents by drawing on the bounding boxes:

from aryn_sdk.partition import partition_file, draw_with_boxes

with open("partition-me.pdf", "rb") as f:
    data = partition_file(
        f,
        use_ocr=True,
        extract_table_structure=True,
        extract_images=True
    )
page_pics = draw_with_boxes("partition-me.pdf", data, draw_table_cells=True)

from IPython.display import display
display(page_pics[0])

Note: visualizing documents requires poppler, a pdf processing library, to be installed. Instructions for installing poppler can be found here

Convert image elements to more useful types, like PIL, or image format typed byte strings

from aryn_sdk.partition import partition_file, convert_image_element

with open("my-favorite-pdf.pdf", "rb") as f:
    data = partition_file(
        f,
        extract_images=True
    )
image_elts = [e for e in data['elements'] if e['type'] == 'Image']

pil_img = convert_image_element(image_elts[0])
jpg_bytes = convert_image_element(image_elts[1], format='JPEG')
png_str = convert_image_element(image_elts[2], format="PNG", b64encode=True)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aryn_sdk-0.1.10.tar.gz (853.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aryn_sdk-0.1.10-py3-none-any.whl (870.5 kB view details)

Uploaded Python 3

File details

Details for the file aryn_sdk-0.1.10.tar.gz.

File metadata

  • Download URL: aryn_sdk-0.1.10.tar.gz
  • Upload date:
  • Size: 853.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for aryn_sdk-0.1.10.tar.gz
Algorithm Hash digest
SHA256 226a299061632ddbfc11d078c7a5ff9a1c5ac5224bafec93ae62fc347d041cae
MD5 04e4fadc49157311eef54a0bc0393949
BLAKE2b-256 d60bd60d97cc4695985a296756d43846b1118fb6f2de1e2bff0a146873bd5c65

See more details on using hashes here.

Provenance

The following attestation bundles were made for aryn_sdk-0.1.10.tar.gz:

Publisher: aryn-sdk_release.yml on aryn-ai/sycamore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aryn_sdk-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: aryn_sdk-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 870.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for aryn_sdk-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 d6e12fc2d49c2e0fb219cec300e94a339384043331031758bb1d67c6f916f5e0
MD5 aa9aec71187af4f6bee635736643655f
BLAKE2b-256 0a25e87653bc14783e01e05643f8d3683d71f73f6f5a1828a538b14ebabcd0ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for aryn_sdk-0.1.10-py3-none-any.whl:

Publisher: aryn-sdk_release.yml on aryn-ai/sycamore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page