Axual Documentation

Axual

    • Introduction
    • Platform overview
    • Choosing the right client
    • Getting Started
      • Guide overview
      • 1. Creating topics
      • 2. Creating applications
      • 3. Producing Data
      • 4. Consuming Data
    • Self Service for Apache Kafka
      • Introduction
      • FAQ
      • Topics
        • Topic Authorizations
        • Stream Browse (Messages)
        • Topic Insights
      • Applications
        • Producers
          • Java Clients
            • Java Kafka Client
          • .Net Clients
            • .Net Kafka Client
          • Python Clients
            • Python Kafka Client
          • REST Client
        • Consumers
          • Java Clients
            • Java Kafka Client
          • .Net Clients
            • .Net Kafka Client
          • Python Clients
            • Python Kafka Client
          • REST Client
        • Monitoring Java applications
        • Application Insights
      • Client Metrics
        • Topic Metrics
          • Message Rate
          • Incoming Byte Rate
          • Outgoing Byte Rate
          • Size in Records
          • Size in Bytes
        • Application Metrics
          • Consumer Lag in Records
          • Consumer Time to Catch Up
        • Partition Metrics
          • Size in Records
          • Size in Bytes
      • Environments
      • Data Masking
      • Audit History
      • Schema Management
      • Users and Groups
        • Authentication & Authorization
        • Roles & Permissions
        • Users
        • Groups
        • Viewer Groups
      • Instances
      • Clusters
      • Tenant
      • Security
        • Enabling security
      • CI/CD support
        • Create a resource
      • Advanced features
        • Synchronize Your Clusters
        • Define Default Kafka Properties
    • Axual Architecture & Components
      • Streaming Components
        • Apache Kafka
          • Strimzi Operator
        • Rest Proxy
          • README
          • Changelog
          • Helm README
          • API
          • Example: Producing data with Rest Proxy
        • Apicurio Schema Registry
          • README
          • Helm README
          • Apicurio Keycloak Realm
          • Migrating from Legacy Schema Registry to Apicurio Schema Registry
        • Schema Registry (Legacy)
      • Governance Components
        • API Gateway
          • README
          • Changelog
          • Helm README
        • Platform Manager
          • README
          • Changelog
          • Helm README
        • Platform UI
          • README
          • Changelog
          • Helm README
        • Topic Browse
          • README
          • Changelog
          • Helm README
        • Keycloak
          • Create and Configure a Keycloak Realm
        • Metrics Exposer
          • README
          • Changelog
          • Helm README
        • Vault
          • Hashicorp Vault setup
        • MySQL
      • Runtime Components
        • Axual Distributor
          • Deploying Distributor
          • Distribution Model
          • Monitoring Distributor
          • Message Distribution
          • Schema Distribution
          • Offset Distribution
          • Changelog
          • Helm README
          • Testing Distribution scenarios
        • KSML Provisioner
          • Changelog
          • Helm README
          • Deploying KSML Provisioner
          • Enabling KSML
          • Starting KSML Applications
        • Platform Metric Provider
      • Init Containers
        • Keystore Provider
    • Operator Manual
      • Infrastructure
        • Infrastructure Requirements
        • Resilience
        • State & Data persistence
      • Deploying Axual
        • Quick setup of the Axual Platform
          • Deploying Axual Streaming and Axual Governance on Kubernetes
          • Deploying Axual Governance on Kubernetes
          • Deploying Axual Governance on OpenShift
        • Ways of deploying Axual (Best practices)
        • Dependencies
        • Axual Streaming & Governance Installation
          • Preparations
          • Install the Axual Streaming
            • Configure Strimzi
            • Configure REST Proxy
            • Configure Apicurio
            • Configure Axual Schema Registry
          • Install the Axual Governance
            • Configure MySQL
            • Configure Keycloak
            • Configure Platform Manager
            • Configure HashiCorp Vault
            • Configure Topic Browse
            • Configure Organization Management
            • Configure API Gateway
            • Configure Platform UI
            • Configure Metrics Exposer
          • Set up HashiCorp Vault and Platform Manager
          • Create Self-Service Resources
          • Quick setup of the Axual Platform
      • Upgrading Axual
      • Upgrade Axual Platform to Axual Streaming & Governance
        • Management Stack Upgrade
        • Browse & Search Upgrade
        • Cluster Stack Upgrade
        • Instance Stack Upgrade
        • After Upgrade
        • Keycloak Upgrade
        • Optional Upgrade
      • Observability
        • Logging
        • Monitoring & Metrics
        • Distributed Tracing
      • Guides & Troubleshooting
        • Troubleshooting
        • Acting on Alerts
        • Security
        • Certificate interactions
        • Adding an Ingress controller
        • Enabling SASL SCRAM-512 in Axual Platform
        • Topic, Consumer Group and Transactional ID Patterns
    • Compatibility Matrix
    • Releases of Axual Platform
      • Axual 2025.1
        • Release Notes
        • Upgrading with Streaming and Governance Charts
    • Axual Terraform Provider
    • Support
Axual 2025.1
  • Axual
    • 2025.2
    • 2025.1
    • 2024.4
    • 2024.3
    • 2024.2
    • 2024.1
    • 2023.4
    • 2023.3
  • Connect
    • Axual-Connect
  • dotNET Client
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Java Client
    • 6
    • 5.8
    • 5.7
    • 5.5
    • 5.4
  • Operations
    • 2024.2
    • 2024.1
    • 2023.4
    • 2023.3
    • 2023.2
    • 2023.1
    • 2022.4
    • 2022.3
    • 2022.2
    • 2022.1
  • REST Proxy
    • 1.9.1
    • 1.7.0
    • 1.6.0
    • 1.5.4
    • 1.5.2
    • 1.5.1
    • 1.5.0
    • 1.4.0
    • 1.3.0
    • 1.2.2
    • 1.2.1
  • Axual
  • Self Service for Apache Kafka
  • Applications
  • Producers
  • Python Clients
2025.2 2025.1 2024.4 2024.3 2024.2 2024.1 2023.4 2023.3

Producing Using Python Clients

Python client library that enables interaction with the Axual Platform.

Choose Python Client

  • Kafka Client

For all executable Python examples, please refer Python Client Examples repository.

Prerequisites

A computer equipped with:

  • Python 3 or above

  • Your favorite IDE

.Net Kafka Client Python Kafka Client