pulsar-producer


Namepulsar-producer JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/vandaimer/pulsar-producer
SummaryCLI that help developers to publish messages into any pulsar topic in order to test features (usually, consumers) that relies on a pulsar consumer
upload_time2022-12-05 20:57:27
maintainer
docs_urlNone
authorLuiz Filipe
requires_python>=3.8,<4.0
licenseMIT
keywords apache-pulsar producer python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pulsar Producer

CLI that allows to send a message into a Apache Pulsar topic

#

Usually, implementing an Apache Pulsar Consumers, you will need to test it before release. Then, it's quite painful that you need to write or change some code in order to test it. Having that said, I have implemented this CLI that can help you with that.

Now, you can have a file with the message you want to send into a specific Apache Pulsar Topic and simply test your Apache Pulsar Consumer easily.

# How to use it

First, you should install the CLI on your machine

`pip install pulsar-producer` or `pip install --user pulsar-producer` if you want make it available only for your user.

> **_NOTE:_**  This package still *not* publish on pypi, only on [testing environment](https://test.pypi.org/project/pulsar-producer/0.1.0/#description)

> **_NOTE:_** pip install -i https://test.pypi.org/simple/ pulsar-producer==0.1.0

Then, you need to have an file with your Apache Pulsar server address. This file SHOULD follow a JSON format.

Example:

[_my-apache-pulsar-configuration.json_](./examples/pulsar-connection.json)

```json
{
        "host": "localhost",
        "port": "6650",
        "topic": "my-topic-name"
}

```

Then, you need to have another file with contains the message you want to publish in your Apache Pulsar topic in order to test your Apache Pulsar Consumer.
This file can contains ANYTHING you want. In this example, let's say you want to publish a JSON structure message.

[_my-message-file-example.json_](./examples/message-file)

```json
{
    "KEY": "THIS IS MY MESSAGE WHICH COULD BE ONLY PURE TEXT (NOT JSON)"
}

```

Now, you just need to run:

`pulsar-producer --pulsar-connection-file ./path-of-your-my-apache-pulsar-configuration-example-json --message-file ./path-or-your-message-file`

# License
MIT

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vandaimer/pulsar-producer",
    "name": "pulsar-producer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "apache-pulsar,producer,python",
    "author": "Luiz Filipe",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/cc/20/d01721178faf01b1eb204da48c38c084fa55ffd882e55f07b802cc84a476/pulsar_producer-0.1.0.tar.gz",
    "platform": null,
    "description": "# Pulsar Producer\n\nCLI that allows to send a message into a Apache Pulsar topic\n\n#\n\nUsually, implementing an Apache Pulsar Consumers, you will need to test it before release. Then, it's quite painful that you need to write or change some code in order to test it. Having that said, I have implemented this CLI that can help you with that.\n\nNow, you can have a file with the message you want to send into a specific Apache Pulsar Topic and simply test your Apache Pulsar Consumer easily.\n\n# How to use it\n\nFirst, you should install the CLI on your machine\n\n`pip install pulsar-producer` or `pip install --user pulsar-producer` if you want make it available only for your user.\n\n> **_NOTE:_**  This package still *not* publish on pypi, only on [testing environment](https://test.pypi.org/project/pulsar-producer/0.1.0/#description)\n\n> **_NOTE:_** pip install -i https://test.pypi.org/simple/ pulsar-producer==0.1.0\n\nThen, you need to have an file with your Apache Pulsar server address. This file SHOULD follow a JSON format.\n\nExample:\n\n[_my-apache-pulsar-configuration.json_](./examples/pulsar-connection.json)\n\n```json\n{\n        \"host\": \"localhost\",\n        \"port\": \"6650\",\n        \"topic\": \"my-topic-name\"\n}\n\n```\n\nThen, you need to have another file with contains the message you want to publish in your Apache Pulsar topic in order to test your Apache Pulsar Consumer.\nThis file can contains ANYTHING you want. In this example, let's say you want to publish a JSON structure message.\n\n[_my-message-file-example.json_](./examples/message-file)\n\n```json\n{\n    \"KEY\": \"THIS IS MY MESSAGE WHICH COULD BE ONLY PURE TEXT (NOT JSON)\"\n}\n\n```\n\nNow, you just need to run:\n\n`pulsar-producer --pulsar-connection-file ./path-of-your-my-apache-pulsar-configuration-example-json --message-file ./path-or-your-message-file`\n\n# License\nMIT\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CLI that help developers to publish messages into any pulsar topic in order to test features (usually, consumers) that relies on a pulsar consumer",
    "version": "0.1.0",
    "split_keywords": [
        "apache-pulsar",
        "producer",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c5db3a3b8b8862d5bc66e4a57f1f2d3d",
                "sha256": "5abf9d0be1793ac8e6185dc50363e81a2b290b36885a9fd50b12f11d56619060"
            },
            "downloads": -1,
            "filename": "pulsar_producer-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5db3a3b8b8862d5bc66e4a57f1f2d3d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 3410,
            "upload_time": "2022-12-05T20:57:26",
            "upload_time_iso_8601": "2022-12-05T20:57:26.020823Z",
            "url": "https://files.pythonhosted.org/packages/7a/13/5f58b9c30894ed27c147c0f6006e1bd21d735e6ff91700eccde4995a5ad9/pulsar_producer-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "194fa01545b77ac31b0bcd9610870439",
                "sha256": "c99c920134e4ab840094327407a18268df328bf020ee809d5be78e55d7fdf3e5"
            },
            "downloads": -1,
            "filename": "pulsar_producer-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "194fa01545b77ac31b0bcd9610870439",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 2932,
            "upload_time": "2022-12-05T20:57:27",
            "upload_time_iso_8601": "2022-12-05T20:57:27.286944Z",
            "url": "https://files.pythonhosted.org/packages/cc/20/d01721178faf01b1eb204da48c38c084fa55ffd882e55f07b802cc84a476/pulsar_producer-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-05 20:57:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "vandaimer",
    "github_project": "pulsar-producer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pulsar-producer"
}
        
Elapsed time: 0.01399s