diff options
Diffstat (limited to 'python-roborabbit.spec')
| -rw-r--r-- | python-roborabbit.spec | 729 |
1 files changed, 729 insertions, 0 deletions
diff --git a/python-roborabbit.spec b/python-roborabbit.spec new file mode 100644 index 0000000..0d04fa2 --- /dev/null +++ b/python-roborabbit.spec @@ -0,0 +1,729 @@ +%global _empty_manifest_terminate_build 0 +Name: python-roborabbit +Version: 0.4.2 +Release: 1 +Summary: Set up your rabbit instance using a declarative yaml file. +License: Apache-2.0 +URL: https://github.com/alairock/roborabbit +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ac/d4/f2f3c6d31a1b8365fc1d6cdaee651208db923f59f9af9832d307a9b11a64/roborabbit-0.4.2.tar.gz +BuildArch: noarch + +Requires: python3-click +Requires: python3-PyYAML +Requires: python3-aio-pika + +%description +# RoboRabbit +RoboRabbit is a simple to use, opinionated, asynchronous abstraction over amqp/RabbitMQ (using aio_pika) and configuration CLI. + + +## Features +- Create/assert Queues, Exchanges, and Bindings on connection +- Declarative Queue, Exchange, Binding, and Connection configuration using YAML +- Very straight forward async message handling +- Command line interface for bootstrapping rabbit from your roborabbit yaml config file. + +## Installation + +#### pip +$ `pip install roborabbit` + +#### poetry +$ `poetry add roborabbit` + +## Handle queue messages + +The simplest worker possible. Connection information is in the `roborabbit.yaml` file. The method `run()` takes an dictionary with a key/value pair: +- key: `queue` - string, the name of the queue to listen to +- value: `handler` - function, the callback function messages will be sent to + +### Notes + +- Dead letter exchanges/queues are created and bound for you. (default is {queue_name}_dlq and {queue_name}_dlx) +- Messages are `reject`ed and pushed into the dead letter queue when an exception is thrown. +- Messages are `nack`ed and returned to queue when disconnected (asyncio.CancelledError). +- Messages are `ack`ed automatically after the callback has run without exception. +- Multiple queues can be listened to at the same time. +- Connection is honored in the following order + - The `Connection()` class + - Connection parameters defined in your roborabbit.yaml file + - Environment variables (see environment variables section) + - Default RabbitMQ connection values + +### environment variables +- `RABBIT_HOST` default 'localhost' +- `RABBIT_USER` default 'guest' +- `RABBIT_PASS` default 'guest' +- `RABBIT_PORT` default 5432 +- `RABBIT_VIRTUALHOST` default '/' +- `RABBIT_PREFETCH` default 10 + + +### Basic Example +```py +from roborabbit.roborabbit import RoboRabbit +from pathlib import Path + +config_path = Path('roborabbit.yaml') +robo = RoboRabbit(config_path) + +async def queue_handler(msg): + print(msg) # your logic here + +await robo.run({'queue_1', queue_handler}) +``` + +### Explicit connection example + +If you want control over the configuration, you can pass in the roborabbit connection object. + +```py +from roborabbit.connection import Connection +from roborabbit.roborabbit import RoboRabbit +from pathlib import Path + +config_path = Path('roborabbit.yaml') +connection = Connection( + host='not.localhost.com', + username='bob', + password='pas123', + port=4499, + virtualhost='/') + +robo = RoboRabbit(config_path, connection) + +async def queue_handler(msg): + print(msg) # your logic here + +async def work(): + await robo.run({'queue_1', queue_handler}) +``` + +## Command + +`roborabbit --config path/to/roborabbit.yaml` + +### info + +``` +Usage: roborabbit [OPTIONS] + + import yaml config file and creates a dictionary from it + +Options: + --config TEXT Path to rabbit config yaml file + --host TEXT RabbitMQ host + --port TEXT RabbitMQ port + --virtualhost TEXT RabbitMQ virtualhost + --username TEXT RabbitMQ username + --password TEXT RabbitMQ password + --help Show this message and exit. +``` + +## Override environment variables + +``` +RABBIT_USER=guest +RABBIT_PASS=guest +RABBIT_HOST=localhost +RABBIT_PORT=5672 +RABBIT_VHOST=/ +``` + +## Example yaml files + +### Simple declare queue, exchange, and bind + +``` +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 +exchanges: + - name: exchange_1 + type: topic +queues: + - name: queue_1 +bindings: + - from: + type: exchange + name: exchange_1 + to: + type: queue + name: queue_1 + routing_keys: + - records.created +``` + +### Header exchange declaration and binding + +``` +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 +exchanges: + - name: exchange_2 + type: headers +queues: + - name: queue_2 +bindings: + - from: + type: exchange + name: exchange_2 + to: + type: queue + name: queue_1 + bind_options: + - x-match: all + hw-action: header-value +``` + +## All Values Available + +``` +# Connection info +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 + +# Exchange declarations +exchanges: + - name: string + type: topic|headers|direct|fanout # topic is default + durable: false # default + auto_delete: true # default + +# queue declarations +queues: + - name: string + type: quorum # Not required. This is the default and currently only option available (For us, all our queues are quorum. We manually create the queue that needs other requirements). MR welcome + dlq: string # default {queue_name}_dlq + dlx: string # default {queue_name}_dlx + durable: true # default + robust: true # default + auto_delete: false # default + exclusive: false # default + auto_delete_delay: 0 # default + arguments: # rabbit specific key/value pairs + key_1: value_1 + key_2: value_2 + +# bindings +bindings: + - from: + type: exchange + name: string + to: + type: exchange|queue + name: string + routing_keys: + - record.created # list of string, required, unless bind_options is defined + bind_options: # list of `x-match` and `header-key`, required if binding to a header exchange + - x-match: all|any # header type of matcher + header-key: string # header topic to be matched +``` + +## Planned features: +- Simple message publishing +- Expose the underlying channel so you can drop right into aio_pika if you want. + + +%package -n python3-roborabbit +Summary: Set up your rabbit instance using a declarative yaml file. +Provides: python-roborabbit +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-roborabbit +# RoboRabbit +RoboRabbit is a simple to use, opinionated, asynchronous abstraction over amqp/RabbitMQ (using aio_pika) and configuration CLI. + + +## Features +- Create/assert Queues, Exchanges, and Bindings on connection +- Declarative Queue, Exchange, Binding, and Connection configuration using YAML +- Very straight forward async message handling +- Command line interface for bootstrapping rabbit from your roborabbit yaml config file. + +## Installation + +#### pip +$ `pip install roborabbit` + +#### poetry +$ `poetry add roborabbit` + +## Handle queue messages + +The simplest worker possible. Connection information is in the `roborabbit.yaml` file. The method `run()` takes an dictionary with a key/value pair: +- key: `queue` - string, the name of the queue to listen to +- value: `handler` - function, the callback function messages will be sent to + +### Notes + +- Dead letter exchanges/queues are created and bound for you. (default is {queue_name}_dlq and {queue_name}_dlx) +- Messages are `reject`ed and pushed into the dead letter queue when an exception is thrown. +- Messages are `nack`ed and returned to queue when disconnected (asyncio.CancelledError). +- Messages are `ack`ed automatically after the callback has run without exception. +- Multiple queues can be listened to at the same time. +- Connection is honored in the following order + - The `Connection()` class + - Connection parameters defined in your roborabbit.yaml file + - Environment variables (see environment variables section) + - Default RabbitMQ connection values + +### environment variables +- `RABBIT_HOST` default 'localhost' +- `RABBIT_USER` default 'guest' +- `RABBIT_PASS` default 'guest' +- `RABBIT_PORT` default 5432 +- `RABBIT_VIRTUALHOST` default '/' +- `RABBIT_PREFETCH` default 10 + + +### Basic Example +```py +from roborabbit.roborabbit import RoboRabbit +from pathlib import Path + +config_path = Path('roborabbit.yaml') +robo = RoboRabbit(config_path) + +async def queue_handler(msg): + print(msg) # your logic here + +await robo.run({'queue_1', queue_handler}) +``` + +### Explicit connection example + +If you want control over the configuration, you can pass in the roborabbit connection object. + +```py +from roborabbit.connection import Connection +from roborabbit.roborabbit import RoboRabbit +from pathlib import Path + +config_path = Path('roborabbit.yaml') +connection = Connection( + host='not.localhost.com', + username='bob', + password='pas123', + port=4499, + virtualhost='/') + +robo = RoboRabbit(config_path, connection) + +async def queue_handler(msg): + print(msg) # your logic here + +async def work(): + await robo.run({'queue_1', queue_handler}) +``` + +## Command + +`roborabbit --config path/to/roborabbit.yaml` + +### info + +``` +Usage: roborabbit [OPTIONS] + + import yaml config file and creates a dictionary from it + +Options: + --config TEXT Path to rabbit config yaml file + --host TEXT RabbitMQ host + --port TEXT RabbitMQ port + --virtualhost TEXT RabbitMQ virtualhost + --username TEXT RabbitMQ username + --password TEXT RabbitMQ password + --help Show this message and exit. +``` + +## Override environment variables + +``` +RABBIT_USER=guest +RABBIT_PASS=guest +RABBIT_HOST=localhost +RABBIT_PORT=5672 +RABBIT_VHOST=/ +``` + +## Example yaml files + +### Simple declare queue, exchange, and bind + +``` +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 +exchanges: + - name: exchange_1 + type: topic +queues: + - name: queue_1 +bindings: + - from: + type: exchange + name: exchange_1 + to: + type: queue + name: queue_1 + routing_keys: + - records.created +``` + +### Header exchange declaration and binding + +``` +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 +exchanges: + - name: exchange_2 + type: headers +queues: + - name: queue_2 +bindings: + - from: + type: exchange + name: exchange_2 + to: + type: queue + name: queue_1 + bind_options: + - x-match: all + hw-action: header-value +``` + +## All Values Available + +``` +# Connection info +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 + +# Exchange declarations +exchanges: + - name: string + type: topic|headers|direct|fanout # topic is default + durable: false # default + auto_delete: true # default + +# queue declarations +queues: + - name: string + type: quorum # Not required. This is the default and currently only option available (For us, all our queues are quorum. We manually create the queue that needs other requirements). MR welcome + dlq: string # default {queue_name}_dlq + dlx: string # default {queue_name}_dlx + durable: true # default + robust: true # default + auto_delete: false # default + exclusive: false # default + auto_delete_delay: 0 # default + arguments: # rabbit specific key/value pairs + key_1: value_1 + key_2: value_2 + +# bindings +bindings: + - from: + type: exchange + name: string + to: + type: exchange|queue + name: string + routing_keys: + - record.created # list of string, required, unless bind_options is defined + bind_options: # list of `x-match` and `header-key`, required if binding to a header exchange + - x-match: all|any # header type of matcher + header-key: string # header topic to be matched +``` + +## Planned features: +- Simple message publishing +- Expose the underlying channel so you can drop right into aio_pika if you want. + + +%package help +Summary: Development documents and examples for roborabbit +Provides: python3-roborabbit-doc +%description help +# RoboRabbit +RoboRabbit is a simple to use, opinionated, asynchronous abstraction over amqp/RabbitMQ (using aio_pika) and configuration CLI. + + +## Features +- Create/assert Queues, Exchanges, and Bindings on connection +- Declarative Queue, Exchange, Binding, and Connection configuration using YAML +- Very straight forward async message handling +- Command line interface for bootstrapping rabbit from your roborabbit yaml config file. + +## Installation + +#### pip +$ `pip install roborabbit` + +#### poetry +$ `poetry add roborabbit` + +## Handle queue messages + +The simplest worker possible. Connection information is in the `roborabbit.yaml` file. The method `run()` takes an dictionary with a key/value pair: +- key: `queue` - string, the name of the queue to listen to +- value: `handler` - function, the callback function messages will be sent to + +### Notes + +- Dead letter exchanges/queues are created and bound for you. (default is {queue_name}_dlq and {queue_name}_dlx) +- Messages are `reject`ed and pushed into the dead letter queue when an exception is thrown. +- Messages are `nack`ed and returned to queue when disconnected (asyncio.CancelledError). +- Messages are `ack`ed automatically after the callback has run without exception. +- Multiple queues can be listened to at the same time. +- Connection is honored in the following order + - The `Connection()` class + - Connection parameters defined in your roborabbit.yaml file + - Environment variables (see environment variables section) + - Default RabbitMQ connection values + +### environment variables +- `RABBIT_HOST` default 'localhost' +- `RABBIT_USER` default 'guest' +- `RABBIT_PASS` default 'guest' +- `RABBIT_PORT` default 5432 +- `RABBIT_VIRTUALHOST` default '/' +- `RABBIT_PREFETCH` default 10 + + +### Basic Example +```py +from roborabbit.roborabbit import RoboRabbit +from pathlib import Path + +config_path = Path('roborabbit.yaml') +robo = RoboRabbit(config_path) + +async def queue_handler(msg): + print(msg) # your logic here + +await robo.run({'queue_1', queue_handler}) +``` + +### Explicit connection example + +If you want control over the configuration, you can pass in the roborabbit connection object. + +```py +from roborabbit.connection import Connection +from roborabbit.roborabbit import RoboRabbit +from pathlib import Path + +config_path = Path('roborabbit.yaml') +connection = Connection( + host='not.localhost.com', + username='bob', + password='pas123', + port=4499, + virtualhost='/') + +robo = RoboRabbit(config_path, connection) + +async def queue_handler(msg): + print(msg) # your logic here + +async def work(): + await robo.run({'queue_1', queue_handler}) +``` + +## Command + +`roborabbit --config path/to/roborabbit.yaml` + +### info + +``` +Usage: roborabbit [OPTIONS] + + import yaml config file and creates a dictionary from it + +Options: + --config TEXT Path to rabbit config yaml file + --host TEXT RabbitMQ host + --port TEXT RabbitMQ port + --virtualhost TEXT RabbitMQ virtualhost + --username TEXT RabbitMQ username + --password TEXT RabbitMQ password + --help Show this message and exit. +``` + +## Override environment variables + +``` +RABBIT_USER=guest +RABBIT_PASS=guest +RABBIT_HOST=localhost +RABBIT_PORT=5672 +RABBIT_VHOST=/ +``` + +## Example yaml files + +### Simple declare queue, exchange, and bind + +``` +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 +exchanges: + - name: exchange_1 + type: topic +queues: + - name: queue_1 +bindings: + - from: + type: exchange + name: exchange_1 + to: + type: queue + name: queue_1 + routing_keys: + - records.created +``` + +### Header exchange declaration and binding + +``` +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 +exchanges: + - name: exchange_2 + type: headers +queues: + - name: queue_2 +bindings: + - from: + type: exchange + name: exchange_2 + to: + type: queue + name: queue_1 + bind_options: + - x-match: all + hw-action: header-value +``` + +## All Values Available + +``` +# Connection info +host: localhost +username: guest +password: guest +virtualhost: / +port: 5672 + +# Exchange declarations +exchanges: + - name: string + type: topic|headers|direct|fanout # topic is default + durable: false # default + auto_delete: true # default + +# queue declarations +queues: + - name: string + type: quorum # Not required. This is the default and currently only option available (For us, all our queues are quorum. We manually create the queue that needs other requirements). MR welcome + dlq: string # default {queue_name}_dlq + dlx: string # default {queue_name}_dlx + durable: true # default + robust: true # default + auto_delete: false # default + exclusive: false # default + auto_delete_delay: 0 # default + arguments: # rabbit specific key/value pairs + key_1: value_1 + key_2: value_2 + +# bindings +bindings: + - from: + type: exchange + name: string + to: + type: exchange|queue + name: string + routing_keys: + - record.created # list of string, required, unless bind_options is defined + bind_options: # list of `x-match` and `header-key`, required if binding to a header exchange + - x-match: all|any # header type of matcher + header-key: string # header topic to be matched +``` + +## Planned features: +- Simple message publishing +- Expose the underlying channel so you can drop right into aio_pika if you want. + + +%prep +%autosetup -n roborabbit-0.4.2 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-roborabbit -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.2-1 +- Package Spec generated |