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-6.2.25104807008.tar.gz (112.3 kB view details)

Uploaded Source

Built Distribution

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

kodexa-6.2.25104807008-py3-none-any.whl (122.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-6.2.25104807008.tar.gz
  • Upload date:
  • Size: 112.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.11 Linux/5.15.0-1037-azure

File hashes

Hashes for kodexa-6.2.25104807008.tar.gz
Algorithm Hash digest
SHA256 eb16894221cca8393c7708862f9b3c7638bf6edb75b5049f44d263b147ec8748
MD5 b62236a8e7fcf66a2833787b1e52d237
BLAKE2b-256 3bcde09da8e1152650116e18b332ba01be9734d7de4523ea4c49fdaaf69235dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodexa-6.2.25104807008-py3-none-any.whl
  • Upload date:
  • Size: 122.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.11 Linux/5.15.0-1037-azure

File hashes

Hashes for kodexa-6.2.25104807008-py3-none-any.whl
Algorithm Hash digest
SHA256 218232479ad5785798f1fd6b96a636ca5aa91d18a6eaff063cbb24627cd9dd1d
MD5 c5c03e8023b64f865eab0ae4948db12a
BLAKE2b-256 43403c40870c944c94ed09e4bfcbcaf9414089989ea6d6f1694a055a8a11402c

See more details on using hashes here.

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