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.25387497892.tar.gz (112.6 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.25387497892-py3-none-any.whl (122.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-6.2.25387497892.tar.gz
  • Upload date:
  • Size: 112.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.12 Linux/5.15.0-1040-azure

File hashes

Hashes for kodexa-6.2.25387497892.tar.gz
Algorithm Hash digest
SHA256 f7bfebfbcd726a13fb9396e814cd026a0333d76cf99e007137e6f73dc92fc643
MD5 6407849cb3eae5ed732e5130a712620a
BLAKE2b-256 041ac8f3d7430a0e702045d7dd49741853899b77adf67c547955a0683662d62b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kodexa-6.2.25387497892-py3-none-any.whl
Algorithm Hash digest
SHA256 b629e0f1b9f8954e7cbce03d6dfdf516b731f070565bcdac6a485d1b421c1c1e
MD5 f40eb677c843ce4943cba9e9fc3601d0
BLAKE2b-256 98d6b9324f337913ab539a579de003c71877b68f16ac4017f3cdee9376c90edb

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