Skip to main content

Python SDK for the Kodexa Platform

Project description

Kodexa Python SDK

Learn more about Kodexa at kodexa.ai.

Installation & Setup

The project now uses uv for dependency management. To get started:

  1. Install uv (via Homebrew, pipx, or the official installer). For example, using Homebrew:

    brew install uv
    
  2. Create the virtual environment and install dependencies:

    uv sync
    
  3. Run tests to verify your setup:

    uv run pytest
    

Continuous Integration

GitHub Actions workflows now use uv for dependency installation, linting, testing, and publishing. Refer to .github/workflows/ for job definitions if you need to mirror CI behavior locally.

Documentation

Comprehensive documentation, including API references, tutorials, and best practices, is available at the Kodexa Support Portal.

Key documentation sections include:

  • Getting Started Guide
  • API Reference
  • Pipeline Development
  • Model Creation
  • Platform Integration
  • Best Practices

Examples

Check out our documentation for practical examples of:

  • Document processing pipelines
  • Custom model development
  • Content extraction and transformation
  • Platform integration patterns
  • Action implementation

Contributing

We welcome contributions to the Kodexa platform! Whether it's:

  • Bug fixes
  • Feature enhancements
  • Documentation improvements
  • Example contributions

Please see our contributing guide for details on how to get involved.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Support


Built with ❤️ by the Kodexa team

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.4.419873666434.tar.gz (174.6 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.4.419873666434-py3-none-any.whl (189.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-7.4.419873666434.tar.gz
  • Upload date:
  • Size: 174.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kodexa-7.4.419873666434.tar.gz
Algorithm Hash digest
SHA256 49d154f65073c00236c6e158de75ec65f75563155c45a4d78077002d92170ea2
MD5 6cd813b84f36a60edffbaaa7b62d6a92
BLAKE2b-256 06e51d68c0fbacc32f867c77218bc948f78a358285bfd3d167e92d12f06dbfd4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodexa-7.4.419873666434-py3-none-any.whl
  • Upload date:
  • Size: 189.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kodexa-7.4.419873666434-py3-none-any.whl
Algorithm Hash digest
SHA256 c0b91d90d562ddd419f25998a78e5d82318ce40ac1cb336485769f190633a321
MD5 cbd77a7c86d8ab575b76e7f48d35d74c
BLAKE2b-256 45525051f606608ef5d080b6c538f8b8c02bff5340db798b599bf1fd98f2f96b

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