Snippets Groups Projects

Compare History

Merge branch 'feature-#2' into 'develop'

Piotr Maślanka authored 5 months ago

fixes #2

Closes #2

See merge request !2

3b01321a

Name	Last commit	Last update
compile_definitions
coolamqp
docs
stress_tests
tests
.coveragerc
.gitattributes
.gitignore
.gitlab-ci.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
MANIFEST.in
README.md
Vagrantfile
docker-compose.yml
requirements.txt
setup.cfg
setup.py
unittest.cfg

CoolAMQP

Warning!! Since v1.3.1 development has been moved from GitHub to this GitLab. To install CoolAMQP please use

pip install --extra-index-url https://git.dms-serwis.com.pl/api/v4/groups/330/-/packages/pypi/simple coolamqp

Or state it at the beginning of your requirements.txt:

--extra-index-url https://git.dms-serwis.com.pl/api/v4/groups/330/-/packages/pypi/simple
coolamqp

Why CoolAMQP?

tested against all versions of RabbitMQ 3.x (with testing with RabbitMQ 4.x pending)
- automatic tests check against RabbitMQ 3.10 and RabbitMQ 4.0
AMQP 0.9.1 client that's native Python
heavily optimized for speed
geared towards interfacing with RabbitMQ
- supports custom RabbitMQ commands, such as
traceable using opentracing
code coverage is 80% at the moment
120 second stress tests are part of each release

Documentation (WIP) is available at our site.

CoolAMQP uses semantic versioning 2.0.

tl;dr - this is machine-generated compile-time. this generates classes run-time, and there are memoryviews everywhere.

This is borderline absurd.

CoolAMQP is not a direct AMQP client - it also handles reconnections, transactional sending, and so on, mostly via Futures. This means it has a certain opinion on how to handle AMQP, but you can feel the spirit of AMQP underneath. API is stable.

The project is actively maintained and used in a commercial project. Tests can run either on Vagrant (Vagrantfile attached) or Travis CI, and run against RabbitMQ.

CoolAMQP won't touch your messages. It's your bags o'bytes, and your properties.

Enjoy!

Watch out for memoryviews! They're here to stay.

Notes

Assertions are sprinkled throughout the code. You may wish to run with optimizations enabled if you need every CPU cycle you can get.

Note that if you define the environment variable of COOLAMQP_FORCE_SELECT_LISTENER, CoolAMQP will use select-based networking instead of epoll based.

Current limitations

channel flow mechanism is not supported (#11)
confirm=True is not available if you're not RabbitMQ (#8)

Copyright holder change

Since SMOK sp. z o.o. was incorporated, it inherited all SMOK-related IP of previous operator of the service, DMS Serwis s.c., which continues to operate within it's designated company agreement. From there stems the copyright holder name change.

What is here

coolamqp

The core module

stress_tests

A series of stress tests to catch any race conditions

tests

A series of unit tests that need an AMQP server listening.

compile_definitions

A tool to generate definitions.py from the AMQP specification XML.

In order to compile the definitions:

Make sure that you have yapf and requests installed
then perform:

python -m compile_definitions

and you're all set. The only files modified is definitions.py.

docs

Sources for the documentation, available here.

Running unit tests

Unit tests are powered by nose. They require an available AMQP broker. If you host the broker other than localhost, set the env AMQP_HOST to correct value. The default username used is guest, and password is guest.

You can also run unit tests from Docker, if you wish so. To launch the unit test suite:

docker-compose up unittest

To launch the stress test suite

docker-compose up stress_tests