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

Uploaded Source

Built Distribution

kodexa-6.3.36100605332-py3-none-any.whl (149.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-6.3.36100605332.tar.gz
  • Upload date:
  • Size: 137.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.13 Linux/5.15.0-1041-azure

File hashes

Hashes for kodexa-6.3.36100605332.tar.gz
Algorithm Hash digest
SHA256 cc3a4495a2caa72a74159890f12f8b4e7f1289dba2c1fabbaeb0965a4cabebda
MD5 e33070769cb8b176fd970ffa01f73291
BLAKE2b-256 f76e8766d62257e3337cda103dda92e36e56dd895d14834f2bccb6096b2b5b1a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kodexa-6.3.36100605332-py3-none-any.whl
Algorithm Hash digest
SHA256 470ab81c7c02a8c9032ca483a847f3adbb4229b7a832676ca3caa4a30a6c05f4
MD5 403b5aa69f8dac23d24d5a3f037ff927
BLAKE2b-256 3805ee5c333e22c157df13a7cd82b82309101453ebf081b8883ca23737a16c01

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