amqp-client-python 0.1.14__tar.gz → 0.2.0.post1__tar.gz

amqp_client_python-0.2.0.post1/.env.example

@@ -0,0 +1,22 @@
+RABBITMQ_SSL=FALSE
+
+# RABBITMQ_CERT_PATH:       RabbitMQ Certificate
+#                           default value: .certs/analytics/cert.pem
+#
+#                           To generate self-signed certificates,
+#                           use the ./create-self-signed-certs.sh script.
+RABBITMQ_CERT_PATH=.certs/analytics/rabbitmq_cert.pem
+
+# RABBITMQ_KEY_PATH:        RabbitMQ Key
+#                           default value: .certs/analytics/key.pem
+#
+#                           To generate self-signed certificates,
+#                           use the ./create-self-signed-certs.sh script.
+RABBITMQ_KEY_PATH=.certs/analytics/rabbitmq_key.pem
+
+# RABBITMQ_CA_PATH:         RabbitMQ Certificate of the Authentication entity (CA)
+#                           default value: .certs/analytics/ca.pem
+#
+#                           To generate self-signed certificates,
+#                           use the ./create-self-signed-certs.sh script.
+RABBITMQ_CA_PATH=.certs/analytics/ca.pem

amqp_client_python-0.2.0.post1/.flake8

@@ -0,0 +1,6 @@
+[flake8]
+ignore = E722, W503, E402
+max-line-length = 120
+per-file-ignores =
+    conftest.py
+    __init__.py: F401

amqp_client_python-0.2.0.post1/.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Lint
+
+on:
+  push:
+    branches: [ "master", "develop" ]
+  pull_request:
+    branches: [ "master", "develop" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.8"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 amqp_client_python/ --ignore=E722,W503,E402 --count --max-line-length=127 --statistics

amqp_client_python-0.2.0.post1/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+    - name: Build and publish
+      env:
+        PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        poetry config pypi-token.pypi $PYPI_TOKEN
+        poetry build
+        poetry publish

amqp_client_python-0.2.0.post1/.github/workflows/test.yml

@@ -0,0 +1,64 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Tests
+
+on:
+  push:
+    branches: [ "master", "develop" ]
+  pull_request:
+    branches: [ "master", "develop" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+    - name: Generate self-signed certificates
+      run: |
+        # Make the script executable and run it
+        chmod +x ./create-self-signed-certs.sh
+        ./create-self-signed-certs.sh
+
+    - name: Start RabbitMQ container manually
+      run: |
+        # We start the container manually as a step to ensure that the certificate
+        # and config files exist on the host before we try to mount them.
+        docker run -d --name rabbitmq \
+          -p 5672:5672 \
+          -p 5671:5671 \
+          -v ${{ github.workspace }}/.certs/rabbitmq:/etc/ssl:ro \
+          -v ${{ github.workspace }}/external_config/rabbitmq/rabbitmq.conf:/etc/rabbitmq/rabbitmq.conf:ro \
+          -e RABBITMQ_DEFAULT_USER=guest \
+          -e RABBITMQ_DEFAULT_PASS=guest \
+          rabbitmq:3-management-alpine
+    - name: Wait for RabbitMQ to start
+      run: |
+        echo "Waiting for RabbitMQ to initialize..."
+        # Give the container time to start up and apply the configuration.
+        sleep 8
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.8"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pika coverage
+        if [ -f dev_requirements.txt ]; then pip install -r dev_requirements.txt; fi
+    - name: Run unit tests with coverage
+      run: |
+        coverage run --source=amqp_client_python -m pytest -v tests/unit/
+    - name: Run integration tests with coverage
+      run: |
+        coverage run --append --source=amqp_client_python -m pytest -v tests/integration/
+      env:
+        AMQP_DOMAIN: localhost
+    - name: Generate and show combined coverage report
+      run: |
+        coverage report --show-missing

amqp_client_python-0.2.0.post1/.github/workflows/type.yml

@@ -0,0 +1,19 @@
+name: Python Type Checking
+
+on: [push, pull_request]
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install mypy
+    - name: Run mypy
+      run: mypy amqp_client_python/

amqp_client_python-0.2.0.post1/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+node_modules/
+dist/*
+.certs/
+.config/
+*_env/
+site/

amqp_client_python-0.2.0.post1/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: 23.1.0
+    hooks:
+    - id: black
+      language_version: python3.8
+      stages: [commit]
+-   repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
+    hooks:
+    - id: flake8
+      stages: [commit]
+-   repo: local
+    hooks:
+      - id: requirements
+        name: requirements
+        entry: bash -c 'dev_env/bin/pip3 freeze > dev_requirements.txt; git add dev_requirements.txt'
+        language: system
+        pass_filenames: false
+        stages: [commit]

amqp_client_python-0.2.0.post1/.readthedocs.yaml

@@ -0,0 +1,33 @@
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+  jobs:
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+    post_install:
+      - pip install --only doc
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+mkdocs:
+   configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

amqp_client_python-0.2.0.post1/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.autopep8"
+    },
+    "python.formatting.provider": "none"
+}

amqp_client_python-0.2.0.post1/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender identity, sexual orientation, disability, personal appearance, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing others' private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at our [discord channel](https://discord.gg/RkXNeZpNZk). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

{amqp_client_python-0.1.14 → amqp_client_python-0.2.0.post1}/PKG-INFO

@@ -1,27 +1,44 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: amqp-client-python
-Version: 0.1.14
+Version: 0.2.0.post1
 Summary: Python AMQP Client Library
-Home-page: https://github.com/nutes-uepb/amqp-client-python
+Project-URL: Homepage, https://github.com/nutes-uepb/amqp-client-python
+Project-URL: Repository, https://github.com/nutes-uepb/amqp-client-python
+Project-URL: Bug Tracker, https://github.com/nutes-uepb/amqp-client-python/issues
+Project-URL: Source, https://github.com/nutes-uepb/amqp-client-python
+Author-email: NUTES UEPB <dev.seniorsaudemovel@gmail.com>
+Maintainer-email: "João Pedro Miranda C. Hluchan" <berrytern@gmail.com>
 License: Apache-2.0
-Keywords: packaging,dependency,amqp-client-python
-Author: NUTES UEPB
-Author-email: dev.seniorsaudemovel@gmail.com
-Requires-Python: >=3.7,<4.0
+License-File: LICENSE
+Keywords: amqp-client-python,dependency,packaging
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: pika (>=1.3.0,<2.0.0)
-Project-URL: Bug Tracker, https://github.com/nutes-uepb/amqp-client-python/issues
-Project-URL: Repository, https://github.com/nutes-uepb/amqp-client-python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: <4.0,>=3.9
+Requires-Dist: pika<2.0.0,>=1.3.0
 Description-Content-Type: text/markdown
 
 # AMQP Client Python
 
+A Python client providing a high-level abstraction for interacting with RabbitMQ, simplifying message publishing, subscribing, and RPC patterns.
+
+--------
+
 [![License][license-image]][license-url]
 <a href="https://pypi.org/project/amqp-client-python" target="_blank">
     <img src="https://img.shields.io/pypi/v/amqp-client-python?color=%2334D058&label=pypi%20package" alt="Package version">
@@ -33,10 +50,25 @@ Description-Content-Type: text/markdown
 
 
 
+---
 
---------
-Client with high level of abstraction for manipulation of messages in the event bus RabbitMQ.
+**Documentation**: <a href="https://nutes-uepb.github.io/amqp-client-python" target="_blank">https://nutes-uepb.github.io/amqp-client-python</a>
+
+**Source Code**: <a href="https://github.com/nutes-uepb/amqp-client-python" target="_blank">https://github.com/nutes-uepb/amqp-client-python</a>
 
+**Discord Server**: <a href="https://discord.gg/RkXNeZpNZk" target="_blank">https://discord.gg/RkXNeZpNZk</a>
+
+### 🦀 Looking for higher performance? Try `amqp-rs`!
+If you need higher throughput, thread safety, and built-in compression, check out [**amqp-rs**](https://pypi.org/project/amqp-rs/).
+
+It is a high-performance Python extension developed in Rust using PyO3 and `tokio`. It shares a similar API and design philosophy with this library, but adds native thread safety, `zstd`/`zlib`/`lz4` compression, robust TLS/SSL support, and graceful shutdowns. 
+
+You can install it via `pip` or `uv`:
+```bash
+pip install amqp-rs
+```
+
+---
 ### Features:
 - Automatic creation and management of queues, exchanges and channels;
 - Connection persistence and auto reconnect;
@@ -46,19 +78,23 @@ Client with high level of abstraction for manipulation of messages in the event
 - Support for a Remote procedure call _(RPC)_.
 
 
-[//]: # (These are reference links used in the body of this note.)
-[license-image]: https://img.shields.io/badge/license-Apache%202-blue.svg
-[license-url]: https://github.com/nutes-uepb/amqp-client-python/blob/master/LICENSE
-[npm-image]: https://img.shields.io/npm/v/amqp-client-python.svg?color=red&logo=npm
-[npm-url]: https://npmjs.org/package/amqp-client-python
-[downloads-image]: https://img.shields.io/npm/dt/amqp-client-python.svg?logo=npm
-[travis-url]: https://travis-ci.org/nutes-uepb/amqp-client-python
-[coverage-image]: https://coveralls.io/repos/github/nutes-uepb/amqp-client-python/badge.svg
-[coverage-url]: https://coveralls.io/github/nutes-uepb/amqp-client-python?branch=master
-[known-vulnerabilities-image]: https://snyk.io/test/github/nutes-uepb/amqp-client-python/badge.svg?targetFile=requirements.txt
-[known-vulnerabilities-url]: https://snyk.io/test/github/nutes-uepb/amqp-client-python?targetFile=requirements.txt
-[releases-image]: https://img.shields.io/github/release-date/nutes-uepb/amqp-client-python.svg
-[releases-url]: https://github.com/nutes-uepb/amqp-client-python/releases
+### Table of Compatibility
+| version  | compatible with |
+| ---- | ---- |
+| 0.2.0 | 0.2.0 |
+| 0.1.14 | ~0.1.12 |
+
+### Installation
+
+You can install `amqp-client-python` using pip:
+```bash
+pip install amqp-client-python
+```
+
+### Prerequisites
+
+*   Python 3.7+
+*   A running RabbitMQ instance.
 
 ### Examples:
 #### you can use [sync](https://github.com/nutes-uepb/amqp-client-python/blob/develop/amqp_client_python/rabbitmq/eventbus_rabbitmq.py) , [async eventbus](https://github.com/nutes-uepb/amqp-client-python/blob/develop/amqp_client_python/rabbitmq/async_eventbus_rabbitmq.py) and [sync wrapper](https://github.com/nutes-uepb/amqp-client-python/blob/develop/amqp_client_python/rabbitmq/eventbus_wrapper_rabbitmq.py) of async eventbus
@@ -72,34 +108,26 @@ from amqp_client_python import (
     AsyncEventbusRabbitMQ,
     Config, Options
 )
-from amqp_client_python.event import IntegrationEvent, IntegrationEventHandler
 config = Config(Options("queue", "rpc_queue", "rpc_exchange"))
 eventbus = AsyncEventbusRabbitMQ(config)
 # publish
-class ExampleEvent(IntegrationEvent):
-    EVENT_NAME: str = "ExampleEvent"
-    def __init__(self, event_type: str, message = []) -> None:
-        super().__init__(self.EVENT_NAME, event_type)
-        self.message = message
 
-publish_event = ExampleEvent(rpc_exchange, ["message"])
-eventbus.publish(publish_event, rpc_routing_key, "direct")
+eventbus.publish("rpc_exchange", "routing.key", "message_content")
 # subscribe
-class ExampleEventHandler(IntegrationEventHandler):
-    async def handle(self, body) -> None:
-        print(body) # handle messages
-await eventbus.subscribe(subscribe_event, subscribe_event_handle, rpc_routing_key)
+async def subscribe_handler(body) -> None:
+    print(body, type(body), flush=True) # handle messages
+await eventbus.subscribe("rpc_exchange", "routing.key", subscribe_handler)
 # rpc_publish
-response = await eventbus.rpc_client(rpc_exchange, "user.find", ["content_message"])
+response = await eventbus.rpc_client("rpc_exchange", "user.find", "message_content")
 # provider
-async def handle2(*body) -> bytes:
+async def rpc_provider_handler(body) -> bytes:
     print(f"body: {body}")
     return b"content"
-await eventbus.provide_resource("user.find", handle)
+await eventbus.provide_resource("user.find", rpc_provider_handler)
 ```
 </details>
 
-<details><summary>sync usage</summary>
+<details><summary>sync usage(deprecated)</summary>
 
 ```Python
 from amqp_client_python import (
@@ -153,7 +181,7 @@ while running:
         count += 1
         if str(count) != eventbus.rpc_client(rpc_exchange, rpc_routing_key+"2", [f"{count}"]).decode("utf-8"):
             running = False
-        #eventbus.publish(publish_event, rpc_routing_key, "direct")
+        #eventbus.publish(publish_event, rpc_routing_key, "message_content")
         #running = False
     except TimeoutError as err:
         print("timeout!!!: ", str(err))
@@ -168,40 +196,30 @@ while running:
 
 ```Python
 from amqp_client_python import EventbusWrapperRabbitMQ, Config, Options
-from amqp_client_python.event import IntegrationEvent, IntegrationEventHandler
 
-config = Config(Options(queue, rpc_queue, rpc_exchange))
+config = Config(Options("queue", "rpc_queue", "rpc_exchange"))
 eventbus = EventbusWrapperRabbitMQ(config=config)
 
-class ExampleEvent(IntegrationEvent):
-    EVENT_NAME: str = "ExampleEvent"
-    def __init__(self, event_type: str, message = []) -> None:
-        super().__init__(self.EVENT_NAME, event_type)
-        self.message = message
-class ExampleEventHandler(IntegrationEventHandler):
-    async def handle(self, body) -> None:
-        print(body,"subscribe")
+async def subscribe_handler(body) -> None:
+    print(f"{body}", type(body), flush=True)
 
-async def handle(*body):
-    print(body[0], "rpc_provider")
-    return f"{body[0]}".encode("utf-8")
+async def rpc_provider_handler(body) -> bytes:
+    print(f"handle - {body}", type(body), flush=True)
+    return f"{body}".encode("utf-8")
 
-subscribe_event = ExampleEvent(rpc_exchange)
-publish_event = ExampleEvent(rpc_exchange, ["message"])
-subscribe_event_handle = ExampleEventHandler()
 # rpc_provider
-eventbus.provide_resource(rpc_routing_key+"2", handle).result()
+eventbus.provide_resource("user.find", rpc_provider_handler).result()
 # subscribe
-eventbus.subscribe(subscribe_event, subscribe_event_handle, rpc_routing_key).result()
+eventbus.subscribe("rpc_exchange", "routing.key", subscribe_handler).result()
 count = 0
 running = True
 while running:
     try:
         count += 1
         # rpc_client call
-        eventbus.rpc_client(rpc_exchange, rpc_routing_key+"2", [f"{count}"]).result().decode("utf-8")
+        eventbus.rpc_client("rpc_exchange", "user.find", count).result().decode("utf-8")
         # publish
-        eventbus.publish(publish_event, rpc_routing_key, "direct").result()
+        eventbus.publish("rpc_exchange", "routing.key", "message_content").result()
         #running = False
     except KeyboardInterrupt:
         running=False
@@ -211,12 +229,31 @@ while running:
 </details>
 <br />
 
+
+## Sponsors
+The library is provided by NUTES-UEPB.
+<br/>
+<a href="https://nutes.uepb.edu.br/" target="_blank"><img width="250px" src="https://nutes.uepb.edu.br/wp-content/uploads/2018/11/cropped-logo-Nutes-Final.jpg"></a>
+
 ### Know Limitations:
 #### basic eventbus
 <medium><pre>
-When using [**EventbusRabbitMQ**](https://github.com/nutes-uepb/amqp-client-python/blob/master/amqp_client_python/rabbitmq/eventbus_rabbitmq.py#L12) Should not use rpc call inside of rpc provider and subscribe handlers, it may block the ioloop
+When using [**EventbusRabbitMQ**](https://github.com/nutes-uepb/amqp-client-python/blob/master/amqp_client_python/rabbitmq/eventbus_rabbitmq.py#L12) Should not use rpc call inside of rpc provider or subscribe handlers, it may block the ioloop
 #/obs: fixed on other kinds of eventbus, will be removed on nexts releases
 </pre></medium>
 
 
 
+[//]: # (These are reference links used in the body of this note.)
+[license-image]: https://img.shields.io/badge/license-Apache%202-blue.svg
+[license-url]: https://github.com/nutes-uepb/amqp-client-python/blob/master/LICENSE
+[npm-image]: https://img.shields.io/npm/v/amqp-client-python.svg?color=red&logo=npm
+[npm-url]: https://npmjs.org/package/amqp-client-python
+[downloads-image]: https://img.shields.io/npm/dt/amqp-client-python.svg?logo=npm
+[travis-url]: https://travis-ci.org/nutes-uepb/amqp-client-python
+[coverage-image]: https://coveralls.io/repos/github/nutes-uepb/amqp-client-python/badge.svg
+[coverage-url]: https://coveralls.io/github/nutes-uepb/amqp-client-python?branch=master
+[known-vulnerabilities-image]: https://snyk.io/test/github/nutes-uepb/amqp-client-python/badge.svg?targetFile=requirements.txt
+[known-vulnerabilities-url]: https://snyk.io/test/github/nutes-uepb/amqp-client-python?targetFile=requirements.txt
+[releases-image]: https://img.shields.io/github/release-date/nutes-uepb/amqp-client-python.svg
+[releases-url]: https://github.com/nutes-uepb/amqp-client-python/releases