| Name | rabbit-library JSON |
| Version |
1.0.6
JSON |
| download |
| home_page | None |
| Summary | Biblioteca para se conectar ao rabbit e possibilitar trabalhar com o serviço de mensageria |
| upload_time | 2024-05-31 17:58:23 |
| maintainer | None |
| docs_url | None |
| author | Eliézer Schwartz |
| requires_python | <4.0,>=3.11 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Biblioteca para trabalhar com o Rabbit
- Ao instanciar a classe do Rabbit já deve ser passado os parametros de conexão e de reconexão se assim desejar.
- Os parametros de conexão são:
- host, port, virtualhost, username e password
- Os parametros opcionais são:
- reconnect: bool = False
- Se deseja que o fluxo faça um reconnect automatico em alguns casos para se recuperar de erros.
- reconnect_delay: int = 300
- Quanto tempo em segundos deseja que ele tenta ficar se reconectando.
- Valor default se nao informado é 300
- continue_execution: bool = False
- Se deseja que a execução codigo continue após a conexão ser estabelecida, caso for definida como True, a reconexão em caso de falha não será possivel.
- Nesta biblioteca pode ser encontrado os metodos:
- getMessages
- Pegar as mensagens de uma fila e passa a mesma para a função de callback passada para a função getMessages, exemplo:
````
class example():
def process_message(self, channel, method, properties, body):
pass
def example(self):
self.queue.getMessages('name_queue', 'name_exchange', self.process_message, 1)
````
- Parametros:
- queue: str
- Nome da fila que ficará escutando para ler as mensagens.
- exchange: str
- Nome da exchange que a fila está vinculada.
- message_handler: typing.Callable
- Função de processamento da mensagem recebida, serve para fazer o processamento da mensagem que está entrando na fila.
- limit_get_messages: int
- Quantidade de mensagens que deseja pegar por vez do rabbit, por padrão se nao informada será atribuido 1.
- postMessage
- Enviar uma mensagem para uma fila do rabbit.
- Parametros:
- queue: str
- Nome da fila que será colocado a mensagem.
- exchange: str
- Nome da exchange que a fila está vinculada.
- message: str
- Conteúdo da mensagem que será colocado na fila.
- close_connection
- Realizar o fechamento da conexão com o rabbit.
# Requerimentos(DEV):
- Para poder iniciar é preciso ter instalado as dependências abaixo:
- [Python](https://www.python.org/)
- [Pip](https://pip.pypa.io/)
- [Poetry](https://poetry.eustace.io/)
- [Git](https://git-scm.com/)
- [poethepoet](https://github.com/nat-n/poethepoet)
# Como montar a biblioteca e fazer uploud para o pypi.org
- Video de auxlilio pode ser encontrado [aqui](https://youtu.be/YpTuuGBggcE?t=828)
- Url da [biblioteca do pypi](https://pypi.org/project/rabbit-library/).
- O arquivo de LICENCE é necessário para dizer de quem é esta biblioteca, alterar de acordo com as regras e necessidade.
- Como estamos utilizando o poetry é muito simples para fazer o build e uploud para o pipy:
``` poetry publish --build -u USERNAME -p PASSWORD ```
# Testes
- Todos os testes foram desenvolvidos com o pytest, para executar os mesmos pode ser executado o comando ```poetry run coverage run -m pytest``` ou se caso tenha instalado o [poethepoet](https://github.com/nat-n/poethepoet) pode ser executado ```poe cove_tests```
Raw data
{
"_id": null,
"home_page": null,
"name": "rabbit-library",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Eli\u00e9zer Schwartz",
"author_email": "eliezer.mail090@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/67/61/9f2e12c622311a1015d28995258202be6169d7d83a2b10f82e51283db9e6/rabbit_library-1.0.6.tar.gz",
"platform": null,
"description": "# Biblioteca para trabalhar com o Rabbit\n- Ao instanciar a classe do Rabbit j\u00e1 deve ser passado os parametros de conex\u00e3o e de reconex\u00e3o se assim desejar.\n - Os parametros de conex\u00e3o s\u00e3o:\n - host, port, virtualhost, username e password\n - Os parametros opcionais s\u00e3o:\n - reconnect: bool = False\n - Se deseja que o fluxo fa\u00e7a um reconnect automatico em alguns casos para se recuperar de erros.\n - reconnect_delay: int = 300\n - Quanto tempo em segundos deseja que ele tenta ficar se reconectando.\n - Valor default se nao informado \u00e9 300\n - continue_execution: bool = False\n - Se deseja que a execu\u00e7\u00e3o codigo continue ap\u00f3s a conex\u00e3o ser estabelecida, caso for definida como True, a reconex\u00e3o em caso de falha n\u00e3o ser\u00e1 possivel.\n \n- Nesta biblioteca pode ser encontrado os metodos:\n - getMessages\n - Pegar as mensagens de uma fila e passa a mesma para a fun\u00e7\u00e3o de callback passada para a fun\u00e7\u00e3o getMessages, exemplo:\n ````\n class example():\n def process_message(self, channel, method, properties, body):\n pass\n def example(self):\n self.queue.getMessages('name_queue', 'name_exchange', self.process_message, 1)\n ````\n - Parametros:\n - queue: str\n - Nome da fila que ficar\u00e1 escutando para ler as mensagens.\n - exchange: str\n - Nome da exchange que a fila est\u00e1 vinculada.\n - message_handler: typing.Callable\n - Fun\u00e7\u00e3o de processamento da mensagem recebida, serve para fazer o processamento da mensagem que est\u00e1 entrando na fila.\n - limit_get_messages: int\n - Quantidade de mensagens que deseja pegar por vez do rabbit, por padr\u00e3o se nao informada ser\u00e1 atribuido 1.\n - postMessage\n - Enviar uma mensagem para uma fila do rabbit.\n - Parametros:\n - queue: str\n - Nome da fila que ser\u00e1 colocado a mensagem.\n - exchange: str\n - Nome da exchange que a fila est\u00e1 vinculada.\n - message: str\n - Conte\u00fado da mensagem que ser\u00e1 colocado na fila.\n - close_connection\n - Realizar o fechamento da conex\u00e3o com o rabbit.\n# Requerimentos(DEV):\n- Para poder iniciar \u00e9 preciso ter instalado as depend\u00eancias abaixo:\n - [Python](https://www.python.org/)\n - [Pip](https://pip.pypa.io/)\n - [Poetry](https://poetry.eustace.io/)\n - [Git](https://git-scm.com/)\n - [poethepoet](https://github.com/nat-n/poethepoet)\n# Como montar a biblioteca e fazer uploud para o pypi.org\n- Video de auxlilio pode ser encontrado [aqui](https://youtu.be/YpTuuGBggcE?t=828)\n- Url da [biblioteca do pypi](https://pypi.org/project/rabbit-library/).\n- O arquivo de LICENCE \u00e9 necess\u00e1rio para dizer de quem \u00e9 esta biblioteca, alterar de acordo com as regras e necessidade.\n- Como estamos utilizando o poetry \u00e9 muito simples para fazer o build e uploud para o pipy:\n``` poetry publish --build -u USERNAME -p PASSWORD ```\n\n# Testes\n- Todos os testes foram desenvolvidos com o pytest, para executar os mesmos pode ser executado o comando ```poetry run coverage run -m pytest``` ou se caso tenha instalado o [poethepoet](https://github.com/nat-n/poethepoet) pode ser executado ```poe cove_tests```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Biblioteca para se conectar ao rabbit e possibilitar trabalhar com o servi\u00e7o de mensageria",
"version": "1.0.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "238746437467e33151b5829176c492a018d86caf965e5e62e4decb62fd157b64",
"md5": "910b850d31abb633e57be35acd611208",
"sha256": "82f2a5694244ca9b07ee5b4469f0af650bf23d6056ede6877a44aa6108b3b56c"
},
"downloads": -1,
"filename": "rabbit_library-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "910b850d31abb633e57be35acd611208",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 5079,
"upload_time": "2024-05-31T17:58:22",
"upload_time_iso_8601": "2024-05-31T17:58:22.053150Z",
"url": "https://files.pythonhosted.org/packages/23/87/46437467e33151b5829176c492a018d86caf965e5e62e4decb62fd157b64/rabbit_library-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67619f2e12c622311a1015d28995258202be6169d7d83a2b10f82e51283db9e6",
"md5": "18adff106389d66497da2375327bbdc6",
"sha256": "54e38b63c53b4598552ff7379469297e0ba9c8f95d02792c3c114cf13ee25224"
},
"downloads": -1,
"filename": "rabbit_library-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "18adff106389d66497da2375327bbdc6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 4635,
"upload_time": "2024-05-31T17:58:23",
"upload_time_iso_8601": "2024-05-31T17:58:23.698982Z",
"url": "https://files.pythonhosted.org/packages/67/61/9f2e12c622311a1015d28995258202be6169d7d83a2b10f82e51283db9e6/rabbit_library-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-31 17:58:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rabbit-library"
}
