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.4a6041032381.tar.gz (136.5 kB view details)

Uploaded Source

Built Distribution

kodexa-6.3.4a6041032381-py3-none-any.whl (147.7 kB view details)

Uploaded Python 3

File details

Details for the file kodexa-6.3.4a6041032381.tar.gz.

File metadata

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

File hashes

Hashes for kodexa-6.3.4a6041032381.tar.gz
Algorithm Hash digest
SHA256 47241977b875b19add622695d02c71a942e49df21dc4a6f0e1f2d52452aecf57
MD5 03627e3f33256eea583c5f44d7238d0b
BLAKE2b-256 55564415b5d34f0b3e9c849520d614264805746081504846c115a21c71db4044

See more details on using hashes here.

File details

Details for the file kodexa-6.3.4a6041032381-py3-none-any.whl.

File metadata

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

File hashes

Hashes for kodexa-6.3.4a6041032381-py3-none-any.whl
Algorithm Hash digest
SHA256 aa37c6dfd30a5222dc68d895121b91c31482241b28742c1ead7aefe126fa9462
MD5 7c4437664c0a0af5a35f74d2b8707091
BLAKE2b-256 61a16bcb84482dc411ccadf7f26f6c53eca8360240ed99afd5453e2a5723aa4f

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