A wrapper around Kombu to use RabbitMQ, specially on docker images
Started on 2023-08-18
- List some features
- From this repository
To install rab_the_bit, follow these steps:
- Clone the repository:
git clone https://github.com/vliz-be-opsci/py-rabbit.git
- Navigate to the project directory:
cd rab_the_bit
- Install the required dependencies:
make init
- (Optional) Install additional dependencies for development:
make init-dev
Here's an example of how to use rab_the_bit:
import rab_the_bit
# Implement a code example
For more detailed information on the usage of rab_the_bit, refer to the official documentation <https://open-science.vliz.be/rab_the_bit/>.
We welcome contributions from the community to enhance rab_the_bit. If you'd like to contribute, please follow these guidelines:
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and ensure that the code adheres to the project's coding style.
- Write unit tests to cover your changes and ensure they pass.
- Submit a pull request with a clear description of your changes and the problem they solve.
For more information on contributing to Pykg2tbl, please refer to the contribution guidelines </CONTRIBUTING.rst>.
Start using this project with poetry
$ make init # install dependencies
$ make init-dev # includes the previous + adds dependencies for developers
Build Docs
$ make docs
Run Tests
$ make test # to run all tests
$ PYTEST_LOGCONF=debug-logconf.yml python tests/test_demo.py # to run a specific test with specific logging
$ make test-coverage # to run all tests and check the test coverage
Check the code-style and syntax (flake8, black, isort)
$ make check