Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
federicotdn authored Jun 20, 2021
1 parent c022b83 commit ae35010
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,29 @@
![Black](https://img.shields.io/badge/code%20style-black-000000.svg)
![License](https://img.shields.io/github/license/federicotdn/aiorsmq.svg)

Async Python implementation of RSMQ
This is the repository for aiorsmq (**A**sync **IO** **RSMQ**), an asynchronous (`async`/`await`) implementation of [RSMQ](https://github.com/smrchy/rsmq) for Python 3.6+. It aims to provide all the features that RSMQ provides, but for Python users.

## Features
Some of aiorsmq's features are:
- Fully compatible with RSMQ.
- Provides an API similar to that of RSMQ, with some changes done to achieve something more "pythonic".
- All public functions, methods and classes documented.
- Type-annotated and checked with [mypy](http://mypy-lang.org/).
- Tested against Redis, and against the original RSMQ library.

## Installation
To install aiorsmq, run:
```bash
$ pip install aiorsmq
```

## Documentation
(todo)

## Related Projects
For a synchronous implementation of RSMQ for Python, see [PyRSMQ](https://github.com/mlasevich/PyRSMQ).

## License
Distributed under the MIT license.

See [LICENSE](LICENSE) for more details.

0 comments on commit ae35010

Please sign in to comment.