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.1a7902342044.tar.gz (143.4 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file kodexa-7.0.1a7902342044.tar.gz.

File metadata

  • Download URL: kodexa-7.0.1a7902342044.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.1a7902342044.tar.gz
Algorithm Hash digest
SHA256 df4d8ee7ec5c8c5b180528f88511b1e94eb3c63b8fad436f8210e25459cb9219
MD5 f19fd896d1257fca55a06ddaa795a6c3
BLAKE2b-256 bcddb563e8be11a41c9828530992aa31889449a03ceb920f5dc0f40894aa3a74

See more details on using hashes here.

File details

Details for the file kodexa-7.0.1a7902342044-py3-none-any.whl.

File metadata

  • Download URL: kodexa-7.0.1a7902342044-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.1a7902342044-py3-none-any.whl
Algorithm Hash digest
SHA256 65abdb835e1892e2d95bcbbb28cf72e05910da4c0bc482a10ec312944552afce
MD5 7d127758a9330247aa84be22abf25f26
BLAKE2b-256 821c2f96d26f421c1a5bcc8d39bc6cabe263060f796eeb3c66d61c0db02929ff

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