Merge branch 'release/0.1.0'

Author: s3rius

.github/workflows/release.yaml

@@ -0,0 +1,24 @@
+name: Release python package
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install deps
+        uses: knowsuchagency/poetry-install@v1
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+      - name: Release package
+        env:
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+        run: poetry publish --build

.github/workflows/test.yaml

@@ -0,0 +1,86 @@
+name: Testing taskiq-redis
+
+on: push
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install deps
+        uses: knowsuchagency/poetry-install@v1
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+      - name: Run black check
+        run: poetry run black --check .
+  flake8:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install deps
+        uses: knowsuchagency/poetry-install@v1
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+      - name: Run flake8 check
+        run: poetry run flake8 --count .
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install deps
+        uses: knowsuchagency/poetry-install@v1
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+      - name: Run mypy check
+        run: poetry run mypy .
+  pytest:
+    strategy:
+      matrix:
+        py_version: ["3.7", "3.8", "3.9", "3.10"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "${{ matrix.py_version }}"
+      - name: Update pip
+        run: python -m pip install -U pip
+      - name: Install poetry
+        run: python -m pip install poetry
+      - name: Install deps
+        run: poetry install
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+      - name: Update docker-compose
+        uses: KengoTODA/actions-setup-docker-compose@v1
+        with:
+          version: "2.16.0"
+      - name: docker compose up
+        run: docker-compose up -d --wait
+      - name: Run pytest check
+        run: poetry run pytest -vv -n auto --cov="taskiq_nats" .
+      - name: Generate report
+        run: poetry run coverage xml
+      - name: Upload coverage reports to Codecov with GitHub Action
+        uses: codecov/codecov-action@v3
+        if: matrix.py_version == '3.9'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+          verbose: true
+      - name: Stop containers
+        if: always()
+        run: docker-compose down

README.md

@@ -0,0 +1,58 @@
+# Taskiq NATS
+
+Taskiq-nats is a plugin for taskiq that adds NATS broker.
+
+## Installation
+
+To use this project you must have installed core taskiq library:
+
+```bash
+pip install taskiq taskiq-redis
+```
+
+## Usage
+
+Here's a minimal setup example with a broker and one task.
+
+```python
+import asyncio
+from taskiq_nats import NatsBroker
+
+broker = NatsBroker(
+    [
+        "nats://nats1:4222",
+        "nats://nats2:4222",
+    ],
+    queue="random_queue_name",
+)
+
+
+@broker.task
+async def my_lovely_task():
+    print("I love taskiq")
+
+
+async def main():
+    await broker.startup()
+
+    await my_lovely_task.kiq()
+
+    await broker.shutdown()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+## NatsBroker configuration
+
+Here's the constructor parameters:
+
+* `servers` - a single string or a list of strings with nats nodes addresses.
+* `subject` - name of the subect that will be used to exchange tasks betwee workers and clients.
+* `queue` - optional name of the queue. By default NatsBroker broadcasts task to all workers,
+    but if you want to handle every task only once, you need to supply this argument.
+* `result_backend` - custom result backend.
+* `task_id_generator` - custom function to generate task ids.
+* Every other keyword argument will be sent to `nats.connect` function.

docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3.7'
+
+# This docker compose is used for testing.
+# It contains only services required for pytest to run
+# successfully.
+services:
+  nats:
+    image: nats:2.9.15-alpine
+    command:
+      - "-m"
+      - "8222"
+      - "--debug"
+    healthcheck:
+      test:
+        - "CMD"
+        - "sh"
+        - "-c"
+        - "wget http://localhost:8222/healthz -q -O - | xargs | grep ok || exit 1"
+      interval: 5s
+      timeout: 3s
+      retries: 5
+    ports:
+      - 8222:8222
+      - 4222:4222