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.420005002658.tar.gz (174.8 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.420005002658-py3-none-any.whl (189.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodexa-7.4.420005002658.tar.gz
  • Upload date:
  • Size: 174.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","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.420005002658.tar.gz
Algorithm Hash digest
SHA256 8d56e22252f75e88cc203148617482ae1186bb4d1c4d6467f71197b5db2461eb
MD5 f619d18cb315bdc8feb1fbab2677a2bf
BLAKE2b-256 e4e7f4fafb05a3d604000dc7e636020cb7a5e3a60ca8e370a3bdfc7a3e29e6cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodexa-7.4.420005002658-py3-none-any.whl
  • Upload date:
  • Size: 189.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","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.420005002658-py3-none-any.whl
Algorithm Hash digest
SHA256 ab2e12efa8f1ac3eb33ceade55d3c8b441ba85a4cf92ad204645a059017abda3
MD5 6935b10fc4efbfb6814016c4d73fed5e
BLAKE2b-256 9a794efb33f7964d0258b061270effb395d0980f00f84f5c30fe7fbdbbe61c87

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