# confluent-kafka-stubs
This package only contains type hints for the `confluent-kafka` python package. It may be useful to add type checking for `mypy`, or autocompletion in your *language server*.
This package is not endorsed by Confluent.
## Installation
The package can be installed from [PyPI](https://pypi.org/project/confluent-kafka-stubs/), and needs to be installed in a location that tools like `mypy` can access. In my experience, installing it as a user package works well, at least with `neovim` and the official `mypy` package on `Arch Linux`. You can install it as a user package as follows:
```bash
pip install --user confluent-kafka-stubs
```
## Updating
The package can be updated like any other PyPI package.
```bash
pip install --user --upgrade confluent-kafka-stubs
```
## Status
This package should be considered a work in progress.
In the `cimpl` module, I believe all constants have been ported along with the following classes or functions:
- `KafkaError`: class
- `KafkaException`: class
- `Message`: class
- `NewPartitions`: class
- `NewTopic`: class
- `TopicPartition`: class
- `Producer`: class
- `Consumer`: class
- `libversion()`: function
- `version()`: function
Yet to be implemented in the `cimpl` module:
- `_AdminClientImpl`?: class
----
**Note**: unlisted modules have not yet been processed.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/theepic-dev/confluent-kafka-stubs",
"name": "confluent-kafka-stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "kafka,stubs,types",
"author": "The Epic",
"author_email": "theepic.dev.83@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/02/46/625923d25442ce981139ee702ce1cb2e2d0829fdcb1b27d9e6c480150d2c/confluent_kafka_stubs-0.0.3.tar.gz",
"platform": null,
"description": "# confluent-kafka-stubs\n\nThis package only contains type hints for the `confluent-kafka` python package. It may be useful to add type checking for `mypy`, or autocompletion in your *language server*.\n\nThis package is not endorsed by Confluent.\n\n## Installation\n\nThe package can be installed from [PyPI](https://pypi.org/project/confluent-kafka-stubs/), and needs to be installed in a location that tools like `mypy` can access. In my experience, installing it as a user package works well, at least with `neovim` and the official `mypy` package on `Arch Linux`. You can install it as a user package as follows:\n\n```bash\npip install --user confluent-kafka-stubs\n```\n\n## Updating\n\nThe package can be updated like any other PyPI package.\n\n```bash\npip install --user --upgrade confluent-kafka-stubs\n```\n\n## Status\n\nThis package should be considered a work in progress.\n\nIn the `cimpl` module, I believe all constants have been ported along with the following classes or functions:\n\n- `KafkaError`: class\n- `KafkaException`: class\n- `Message`: class\n- `NewPartitions`: class\n- `NewTopic`: class\n- `TopicPartition`: class\n- `Producer`: class\n- `Consumer`: class\n- `libversion()`: function\n- `version()`: function\n\nYet to be implemented in the `cimpl` module:\n\n- `_AdminClientImpl`?: class\n\n----\n\n**Note**: unlisted modules have not yet been processed.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Stub files for confluent-kafka.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://gitlab.com/theepic-dev/confluent-kafka-stubs",
"Repository": "https://gitlab.com/theepic-dev/confluent-kafka-stubs"
},
"split_keywords": [
"kafka",
"stubs",
"types"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f21a609237e2484af10ab3ca2c7b0840dc416bc597689fb4333297e472469c24",
"md5": "958be09775ac70016828fc7304363e05",
"sha256": "a9154e5f6bfbcf644f6e9c133dfc180995afbec965e1fc0a371901ee963fa2ec"
},
"downloads": -1,
"filename": "confluent_kafka_stubs-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "958be09775ac70016828fc7304363e05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 9450,
"upload_time": "2023-06-12T15:43:43",
"upload_time_iso_8601": "2023-06-12T15:43:43.324839Z",
"url": "https://files.pythonhosted.org/packages/f2/1a/609237e2484af10ab3ca2c7b0840dc416bc597689fb4333297e472469c24/confluent_kafka_stubs-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0246625923d25442ce981139ee702ce1cb2e2d0829fdcb1b27d9e6c480150d2c",
"md5": "062d0b0a4626c27f2d0501ef14beb8b1",
"sha256": "97597a28eba0293982d746e66b3229fd8399eb10b8423596a2eeba33b1dd7d9f"
},
"downloads": -1,
"filename": "confluent_kafka_stubs-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "062d0b0a4626c27f2d0501ef14beb8b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 8735,
"upload_time": "2023-06-12T15:43:44",
"upload_time_iso_8601": "2023-06-12T15:43:44.685974Z",
"url": "https://files.pythonhosted.org/packages/02/46/625923d25442ce981139ee702ce1cb2e2d0829fdcb1b27d9e6c480150d2c/confluent_kafka_stubs-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-12 15:43:44",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "theepic-dev",
"gitlab_project": "confluent-kafka-stubs",
"lcname": "confluent-kafka-stubs"
}
JSON