Skip to main content

Python SDK for the Kodexa Platform

Project description

Kodexa

Build and Package with Poetry

img.png

Kodexa is a platform for building intelligent document processing pipelines. It is a set of tools and services that allow you to build a pipeline that can take a document, extract the content, and then process it to extract the information you need.

It is built on a set of core principles:

  • Document Centric - Kodexa is built around the idea of a document. A document is a collection of content nodes that are connected together. This is a powerful model that allows you to build pipelines that can extract content from a wide range of sources.

  • Pipeline Oriented - Kodexa is built around the idea of a pipeline. A pipeline is a series of steps that can be executed on a document. This allows you to build a pipeline that can extract content from a wide range of sources.

  • Extensible - Kodexa is built around the idea of a pipeline. A pipeline is a series of steps that can be executed on a document. This allows you to build a pipeline that can extract content from a wide range of sources.

  • Label Driven - Kodexa focuses on the idea of labels. Labels are a way to identify content within a document and then use that content to drive the processing of the document.

Python SDK

This repository contains the Python SDK for Kodexa. The SDK is the primary way to interact with Kodexa. It allows you to define actions, models, and pipelines that can be executed on Kodexa. It also includes a complete SDK client for working with a Kodexa platform instance.

Documentation & Examples

Documentation is available at the Kodexa Documentation Portal

Current Development

BUILD VERSION FLOW build-version-flow.png Build version will differ based on the branches that are published to pypi.

GITHUB PROCESS github-process.png Changes that contain bugs, features, and fixes should first be pushed to the test branch. Once these changes are thoroughly tested, they can be submitted as a pull request to the main branch. The pull request should be reviewed and approved by an appropriate person before the changes can be merged.

Set-up

We use poetry to manage our dependencies, so you can install them with:

poetry install

You can then run the tests with:

poetry run pytest

Contributing

We welcome contributions to the Kodexa platform. Please see our contributing guide for more details.

License

Apache 2.0

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

kodexa-7.0.7898633185.tar.gz (143.4 kB view details)

Uploaded Source

Built Distribution

kodexa-7.0.7898633185-py3-none-any.whl (154.8 kB view details)

Uploaded Python 3

File details

Details for the file kodexa-7.0.7898633185.tar.gz.

File metadata

  • Download URL: kodexa-7.0.7898633185.tar.gz
  • Upload date:
  • Size: 143.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.13 Linux/6.2.0-1019-azure

File hashes

Hashes for kodexa-7.0.7898633185.tar.gz
Algorithm Hash digest
SHA256 32b36b1d7a66a8a56898ec99598dd8106a92ea5654f42e441b76e9c3e5e38218
MD5 7e45b49cdc2b53ccf429eb7db31ec867
BLAKE2b-256 b774b0ee140043e13cc9b2fbff93e76c0353ec5a75fc1d32566908c21ec493be

See more details on using hashes here.

File details

Details for the file kodexa-7.0.7898633185-py3-none-any.whl.

File metadata

  • Download URL: kodexa-7.0.7898633185-py3-none-any.whl
  • Upload date:
  • Size: 154.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.13 Linux/6.2.0-1019-azure

File hashes

Hashes for kodexa-7.0.7898633185-py3-none-any.whl
Algorithm Hash digest
SHA256 e7601c4dfe503e645b719439588982faad3e7b5edfae42233b5515165d296523
MD5 6cbb82573057797b328bfe26db3ba070
BLAKE2b-256 d93d502f4983513b28f14b1b96a43e1af834b2e5828159aea401147a20357d71

See more details on using hashes here.

Supported by

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