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.3.37315190663.tar.gz (139.0 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.3.37315190663-py3-none-any.whl (150.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kodexa-6.3.37315190663.tar.gz
Algorithm Hash digest
SHA256 f10b08769988ca222c786bdbf3b5e5a0f1db5f03923a90ec56555f9428decc9d
MD5 968c0846a69a4b01addf9e42c8f29f49
BLAKE2b-256 a8c62caa3301b5b2abbf63eb17abd3e4f8897fd2e2994a21a256baf9334dd42c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kodexa-6.3.37315190663-py3-none-any.whl
Algorithm Hash digest
SHA256 67e57d78dc8e35f9f56aae7b6cc037c412f6415ad164924add93ce57107f1b78
MD5 32128e79812f670d3a87baf650c883f7
BLAKE2b-256 c18fe6981eeec13e0e9d6d947e337194da7a901315a639fc8595cea0ca832a9e

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