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

Uploaded Source

Built Distribution

kodexa-6.3.36851379062-py3-none-any.whl (149.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-6.3.36851379062.tar.gz
  • Upload date:
  • Size: 138.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.13 Linux/6.2.0-1015-azure

File hashes

Hashes for kodexa-6.3.36851379062.tar.gz
Algorithm Hash digest
SHA256 8d41068a7c54e54ff4bd71e2afe759ec66b7bf6075b5543017b3dd842c64e31f
MD5 fdb82787c4797ac66ba0a9d18b4e8279
BLAKE2b-256 1aa4b552110b57d72639a038a0ae0d2373e7322cd64b7a4b64f5f49b85281c48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodexa-6.3.36851379062-py3-none-any.whl
  • Upload date:
  • Size: 149.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.13 Linux/6.2.0-1015-azure

File hashes

Hashes for kodexa-6.3.36851379062-py3-none-any.whl
Algorithm Hash digest
SHA256 33d11d1419e2ad40b49965d76b055469c0c527acf2234ec3373f0745664addd8
MD5 e06ff4cbdd626846a4c06358a6c1f59f
BLAKE2b-256 4797d0e2e5af6bceea8ee6aa10d48146f546fbd741bb308f893fa291af1ba2eb

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