Skip to main content

A Python microframework for easy communication with Kafka.

Project description

pypi Main Workflow Status Main Workflow Status pre-commit black license

theTrial is a microframework designed to provide a simple interface for interacting with Kafka. It simplifies the process of setting up consumers and producers for Kafka topics using Pythonic decorators. Under the hood, it uses confluent-kafka to communicate synchronously with Kafka clusters.

Installation

Install from pip:

python -m pip install theTrial

Quick Start

Here’s a simple example to get you started:

from theTrial import TheTrial

app = TheTrial()

Settings Configuration

For a detailed explanation and additional configuration options, refer to the official Confluent documentation: Confluent Kafka Python Documentation.

User-Defined Settings

Logging Configuration

theTrial employs and extends Python’s built-in logging module for system logging.

CLI Commands

theTrial includes a set of CLI commands to set up and manage your projects.

Start Command

To initialize a new project structure, use the start command:

theTrial start --name [YOUR_APP_NAME]

By default, the main app file will be named app.py. You can specify a different name using the --name option.

This command will:

  • Create the main app file ([YOUR_APP_NAME].py).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

the_trial-2.0.0.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

the_trial-2.0.0-py3-none-any.whl (4.4 kB view hashes)

Uploaded Python 3

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