========
theTrial
========
.. DYNAMIC
.. image:: https://img.shields.io/pypi/v/TODO
:target: https://pypi.org/project/TODO
:alt: pypi
.. image:: https://github.com/donMichaelL/test_package/actions/workflows/main.yaml/badge.svg?branch=main
:target: https://github.com/donMichaelL/test_package/actions/workflows/main.yaml
:alt: Main Workflow Status
.. image:: https://img.shields.io/github/actions/workflow/status/donMichaelL/test_package/main.yaml.svg?branch=main&style=for-the-badge
:target: https://github.com/donMichaelL/test_package/actions/workflows/main.yaml
:alt: Main Workflow Status
.. STATIC
.. image:: https://img.shields.io/badge/pre--commit-enabled-%2300A36C%09
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. image:: https://img.shields.io/badge/Code_Style-black-black?color=black
:target: https://github.com/psf/black
:alt: black
.. image:: https://img.shields.io/badge/License-MIT-blue
:target: https://github.com/donMichaelL/theTrial/blob/master/LICENSE
:alt: 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 <https://github.com/confluentinc/confluent-kafka-python>`_ to communicate synchronously with Kafka clusters.
Installation
------------
Install from pip:
.. code-block:: bash
python -m pip install theTrial
Quick Start
-----------
Here's a simple example to get you started:
.. code-block:: python
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 <https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html>`_.
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:
.. code-block:: bash
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`).
Raw data
{
"_id": null,
"home_page": null,
"name": "the-trial",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "consumer, kafka, microframework, producer, python",
"author": null,
"author_email": "Michael Loukeris <mloukeris@di.uoa.gr>",
"download_url": "https://files.pythonhosted.org/packages/d7/49/bc19c961c3a34c81c89cbcd40446eb4afe8dffab04aeb6f0ad5fefdd05c6/the_trial-2.0.0.tar.gz",
"platform": null,
"description": "========\ntheTrial\n========\n\n.. DYNAMIC\n\n.. image:: https://img.shields.io/pypi/v/TODO\n :target: https://pypi.org/project/TODO\n :alt: pypi\n\n.. image:: https://github.com/donMichaelL/test_package/actions/workflows/main.yaml/badge.svg?branch=main\n :target: https://github.com/donMichaelL/test_package/actions/workflows/main.yaml\n :alt: Main Workflow Status\n\n.. image:: https://img.shields.io/github/actions/workflow/status/donMichaelL/test_package/main.yaml.svg?branch=main&style=for-the-badge\n :target: https://github.com/donMichaelL/test_package/actions/workflows/main.yaml\n :alt: Main Workflow Status\n\n.. STATIC\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-%2300A36C%09\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n\n.. image:: https://img.shields.io/badge/Code_Style-black-black?color=black\n :target: https://github.com/psf/black\n :alt: black\n\n.. image:: https://img.shields.io/badge/License-MIT-blue\n :target: https://github.com/donMichaelL/theTrial/blob/master/LICENSE\n :alt: license\n\n``theTrial`` is a microframework designed to provide a simple interface for interacting with Kafka.\nIt simplifies the process of setting up consumers and producers for Kafka topics using Pythonic decorators.\nUnder the hood, it uses `confluent-kafka <https://github.com/confluentinc/confluent-kafka-python>`_ to communicate synchronously with Kafka clusters.\n\nInstallation\n------------\n\nInstall from pip:\n\n.. code-block:: bash\n\n python -m pip install theTrial\n\nQuick Start\n-----------\n\nHere's a simple example to get you started:\n\n.. code-block:: python\n\n from theTrial import TheTrial\n\n app = TheTrial()\n\n\nSettings Configuration\n----------------------\n\nFor a detailed explanation and additional configuration options, refer to the official Confluent documentation: `Confluent Kafka Python Documentation <https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html>`_.\n\nUser-Defined Settings\n^^^^^^^^^^^^^^^^^^^^^\n\n\nLogging Configuration\n---------------------\n\n``theTrial`` employs and extends Python's built-in logging module for system logging.\n\nCLI Commands\n------------\n\n`theTrial` includes a set of CLI commands to set up and manage your projects.\n\nStart Command\n^^^^^^^^^^^^^\n\nTo initialize a new project structure, use the `start` command:\n\n.. code-block:: bash\n\n theTrial start --name [YOUR_APP_NAME]\n\nBy default, the main app file will be named `app.py`. You can specify a different name using the ``--name`` option.\n\nThis command will:\n\n- Create the main app file (`[YOUR_APP_NAME].py`).\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python microframework for easy communication with Kafka.",
"version": "2.0.0",
"project_urls": {
"Changelog": "https://github.com/donMichaelL/theTrial",
"Homepage": "https://github.com/donMichaelL/theTrial",
"Twitter": "https://twitter.com/MichaelLoukeris"
},
"split_keywords": [
"consumer",
" kafka",
" microframework",
" producer",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62b9505eee19402c0365e7a5bef60b0d6dc4f6036a1196b80e4336230d2542d2",
"md5": "d8a83d65932ca744f3839fdd5cb40b5d",
"sha256": "bd9e2f0642cd1241a944a282e2309dcaa914f04dd04a8abcdaad732f47c9932e"
},
"downloads": -1,
"filename": "the_trial-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8a83d65932ca744f3839fdd5cb40b5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4448,
"upload_time": "2024-10-17T11:08:19",
"upload_time_iso_8601": "2024-10-17T11:08:19.469782Z",
"url": "https://files.pythonhosted.org/packages/62/b9/505eee19402c0365e7a5bef60b0d6dc4f6036a1196b80e4336230d2542d2/the_trial-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d749bc19c961c3a34c81c89cbcd40446eb4afe8dffab04aeb6f0ad5fefdd05c6",
"md5": "bdb6561d340e56bfb447a1cc8aa92892",
"sha256": "29d4631fd0e260cb0a3540c1ab7ae9f042f838d41f08185e628bc9697f501edf"
},
"downloads": -1,
"filename": "the_trial-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "bdb6561d340e56bfb447a1cc8aa92892",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4465,
"upload_time": "2024-10-17T11:08:20",
"upload_time_iso_8601": "2024-10-17T11:08:20.995641Z",
"url": "https://files.pythonhosted.org/packages/d7/49/bc19c961c3a34c81c89cbcd40446eb4afe8dffab04aeb6f0ad5fefdd05c6/the_trial-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 11:08:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "donMichaelL",
"github_project": "theTrial",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "the-trial"
}
JSON
