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

Uploaded Source

Built Distribution

kodexa-6.3.35784482159-py3-none-any.whl (122.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kodexa-6.3.35784482159.tar.gz
Algorithm Hash digest
SHA256 1f846d639182300c9acc81265eb255ae70b6a2ca4a315c7ab8ccba33d83e51b4
MD5 d84f646afd85c1d910a97e8aafbecd63
BLAKE2b-256 30766eda41bdb2111ae756e206bb95124e37cb1c8720d7eb402c8422f72ac6ef

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kodexa-6.3.35784482159-py3-none-any.whl
Algorithm Hash digest
SHA256 169cec73c509c4c47a91d3c1515752feffd324e87cf89fc90b93ff8e26facab0
MD5 30358b490c7ccf8e2eb642302340fd41
BLAKE2b-256 f84c014faeed77947cb21182d1b4f9d0104e1a2c845c12aaa6ecea1cb0bfc603

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