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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-7.4.419866695523.tar.gz
  • Upload date:
  • Size: 174.5 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.419866695523.tar.gz
Algorithm Hash digest
SHA256 79b06e9b8f584838d4eb9e6267bdf0365754780b371176c59d27db1245f85978
MD5 dc536a9a1d7679f46696cb8bda639f66
BLAKE2b-256 f0564c3e980f64234f1ab414414bb9f12600fc085774e7f5396e94f1ca9ac965

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodexa-7.4.419866695523-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.419866695523-py3-none-any.whl
Algorithm Hash digest
SHA256 ae2dff5547aff34db414279658060e33e1a45decacd1b3d60ffbc6dbebed7ade
MD5 e754249f8c636c9913f35766d6c04c57
BLAKE2b-256 6a50609f9eef74dba0b03c2cd1d2038ed1abae5c6b164611f6d599d0b0a3ac64

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