| Name | pypz-kafka-io JSON |
| Version |
0.9.3
JSON |
| download |
| home_page | None |
| Summary | Provides a Kafka implementation of the ChannelInput/OutputPort in pypz. |
| upload_time | 2024-08-02 04:37:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | Apache-2.0 |
| keywords |
pypz
plugin
kafka
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Description
This package contains the Kafka implementation of the Input-/OutputPortPlugin
interface of *pypz*. It enables the operators to send and receive data records
in a real streaming fashion.
Check the [documentation](https://lazlowa.github.io/pypz-python/plugins/kafka_io.html) for
more details.
# Install
The python artifact is hosted on https://pypi.org/, so you can install
it via pip:
```shell
pip install pypz-kafka-io
```
If you want to work on it locally, then you should install in editable mode:
```shell
pip install -e ./plugins/kafka_io
```
# Test
You can run tests against an existing Kafka cluster, however, it is
more convenient and safe to use a local test cluster.
1. Run the [confluent image](https://hub.docker.com/r/confluentinc/confluent-local) to start a local cluster
```shell
docker run --name kafka-test-cluster -d --rm -p 9092:9092 confluentinc/confluent-local
```
2. Install the subproject in editable more.
```shell
pip install -e ./plugins/kafka_io
```
3. To run the tests locally, you need to execute the following command:
```shell
python -m unittest discover .\plugins\kafka_io\test\ -p "*.py"
```
4. Delete cluster
```shell
docker stop kafka-test-cluster
```
## Known issues
Due to the fact that the test execution is sometimes faster than the Kafka
cluster, there might be failed tests. Although there are already several
delays inserted into the test code, it still can happen. Try to rerun the
test and give a notification to the maintainer(s). Thank you.
# Build
Before you build, you will need to install the "build" package:
```shell
pip install build
```
Then from the subproject's root, you will need to execute the following command:
```shell
python -m build
```
It will create the source distribution and the wheel file in the "dist" folder.
Raw data
{
"_id": null,
"home_page": null,
"name": "pypz-kafka-io",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "pypz, plugin, kafka",
"author": null,
"author_email": "Laszlo Anka <laszlo.anka@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/43/f0/dc114a791af5d0600c72235037802c5458d7e3d0ec10351058380b878474/pypz_kafka_io-0.9.3.tar.gz",
"platform": null,
"description": "# Description\n\nThis package contains the Kafka implementation of the Input-/OutputPortPlugin \ninterface of *pypz*. It enables the operators to send and receive data records\nin a real streaming fashion.\n\nCheck the [documentation](https://lazlowa.github.io/pypz-python/plugins/kafka_io.html) for\nmore details.\n\n# Install\n\nThe python artifact is hosted on https://pypi.org/, so you can install\nit via pip:\n\n```shell\npip install pypz-kafka-io\n```\n\nIf you want to work on it locally, then you should install in editable mode:\n\n```shell\npip install -e ./plugins/kafka_io\n```\n\n# Test\n\nYou can run tests against an existing Kafka cluster, however, it is\nmore convenient and safe to use a local test cluster.\n\n\n1. Run the [confluent image](https://hub.docker.com/r/confluentinc/confluent-local) to start a local cluster\n```shell\ndocker run --name kafka-test-cluster -d --rm -p 9092:9092 confluentinc/confluent-local\n```\n2. Install the subproject in editable more.\n```shell\npip install -e ./plugins/kafka_io\n```\n3. To run the tests locally, you need to execute the following command:\n```shell\npython -m unittest discover .\\plugins\\kafka_io\\test\\ -p \"*.py\"\n```\n4. Delete cluster\n```shell\ndocker stop kafka-test-cluster\n```\n\n## Known issues\n\nDue to the fact that the test execution is sometimes faster than the Kafka\ncluster, there might be failed tests. Although there are already several\ndelays inserted into the test code, it still can happen. Try to rerun the\ntest and give a notification to the maintainer(s). Thank you.\n\n# Build\n\nBefore you build, you will need to install the \"build\" package:\n\n```shell\npip install build\n```\n\nThen from the subproject's root, you will need to execute the following command:\n\n```shell\npython -m build\n```\n\nIt will create the source distribution and the wheel file in the \"dist\" folder.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Provides a Kafka implementation of the ChannelInput/OutputPort in pypz.",
"version": "0.9.3",
"project_urls": {
"Documentation": "https://pypz.dev",
"Repository": "https://github.com/lazlowa/pypz-python"
},
"split_keywords": [
"pypz",
" plugin",
" kafka"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ff7a9c7c24de6f4c7f3502b7b149a55b3ac8c26e039c14695906b59a4bd49c7",
"md5": "8763a60640f0075fc8152ab5d5246a15",
"sha256": "dd6da0c0125a478ddc1e27b2341e10a0eaae8b7608599ab0322a3d412c740ebb"
},
"downloads": -1,
"filename": "pypz_kafka_io-0.9.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8763a60640f0075fc8152ab5d5246a15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 12827,
"upload_time": "2024-08-02T04:37:15",
"upload_time_iso_8601": "2024-08-02T04:37:15.467849Z",
"url": "https://files.pythonhosted.org/packages/2f/f7/a9c7c24de6f4c7f3502b7b149a55b3ac8c26e039c14695906b59a4bd49c7/pypz_kafka_io-0.9.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "43f0dc114a791af5d0600c72235037802c5458d7e3d0ec10351058380b878474",
"md5": "a95a607f7ac03a974a9ad3e2170bf3db",
"sha256": "0705ffbb1bab40e76b02361d02c541c810bcd8c424ad6f2032cec95d1a7b31b4"
},
"downloads": -1,
"filename": "pypz_kafka_io-0.9.3.tar.gz",
"has_sig": false,
"md5_digest": "a95a607f7ac03a974a9ad3e2170bf3db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 12806,
"upload_time": "2024-08-02T04:37:16",
"upload_time_iso_8601": "2024-08-02T04:37:16.879412Z",
"url": "https://files.pythonhosted.org/packages/43/f0/dc114a791af5d0600c72235037802c5458d7e3d0ec10351058380b878474/pypz_kafka_io-0.9.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 04:37:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lazlowa",
"github_project": "pypz-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pypz-kafka-io"
}
