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.37331156649.tar.gz (139.2 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.37331156649-py3-none-any.whl (150.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-6.3.37331156649.tar.gz
  • Upload date:
  • Size: 139.2 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.37331156649.tar.gz
Algorithm Hash digest
SHA256 0dc5f38ac1301435cc3343c6e3cc98fce039840db9866d4a551bcc94703e2e1c
MD5 d9f93d8db52af1546de5c6cc0102f3e4
BLAKE2b-256 ba46331b9dcc90384c915bc904cab913f8e70ae5e01aa58ff2fa9eed2d718d6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodexa-6.3.37331156649-py3-none-any.whl
  • Upload date:
  • Size: 150.4 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.37331156649-py3-none-any.whl
Algorithm Hash digest
SHA256 a5fc76c099c77f8d01f8ddb8e0b8220940c88f2157d02fc7db86fbe6c206c56c
MD5 7955e4089008ff935fb84fa1d09cc7bd
BLAKE2b-256 f47ac33318772bd291df1c65511bb9870dca4ea8a6aab6125ffdc530afe27ece

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