Merge branch 'release/0.1.5'

Author: s3rius

.github/workflows/release.yml

@@ -9,26 +9,37 @@ jobs:
   deploy_docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Install dependencies
-        uses: borales/[email protected]
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
         with:
-          cmd: install # will run `yarn install` command
-      - name: Build docs
-        uses: borales/[email protected]
+          version: 7
+          run_install: true
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
         with:
-          cmd: docs:build -d docs_dist # will run `docs:build -d docs_dist` command
+          node-version: 18
+          cache: pnpm
+
+      - name: Build docs
+        run: |-
+          pnpm docs:build
+
       - name: Setup git
         run: |
           git config --global lfs.allowincompletepush true
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           personal_token: ${{ secrets.PERSONAL_TOKEN }}
           external_repository: taskiq-python/taskiq-python.github.io
           publish_dir: ./docs_dist
-          user_name: 'github-actions[bot]'
-          user_email: 'github-actions[bot]@users.noreply.github.com'
+          user_name: "github-actions[bot]"
+          user_email: "github-actions[bot]@users.noreply.github.com"
+
   deploy:
     runs-on: ubuntu-latest
     steps:

docs/.vuepress/config.ts

@@ -0,0 +1,51 @@
+import { defineUserConfig } from "vuepress";
+import { searchProPlugin } from "vuepress-plugin-search-pro";
+import { hopeTheme } from "vuepress-theme-hope";
+
+export default defineUserConfig({
+  lang: "en-US",
+  title: "Taskiq",
+  description: "Distributed task queue with full async support",
+  head: [
+    [
+      "meta",
+      {
+        property: "og:image",
+        content: "https://taskiq-python.github.io/logo.svg",
+      },
+    ],
+  ],
+
+  theme: hopeTheme({
+    hostname: "https://taskiq-python.github.io",
+    logo: "/logo.svg",
+
+    repo: "taskiq-python/taskiq",
+    docsBranch: "master",
+    docsDir: "docs",
+
+    navbarAutoHide: "none",
+    sidebar: "structure",
+
+    pure: true,
+    backToTop: false,
+
+    plugins: {
+      copyCode: {
+        showInMobile: true,
+      },
+
+      mdEnhance: {
+        tabs: true,
+        mermaid: true,
+      },
+
+      sitemap: {
+        changefreq: "daily",
+        sitemapFilename: "sitemap.xml",
+      },
+    },
+  }),
+
+  plugins: [searchProPlugin({ indexContent: true })],
+});

docs/available-components/README.md

@@ -1,13 +1,13 @@
 ---
 order: 1
 dir:
-    order: 3
+  order: 3
 ---
 
 # Available components
 
 In this section, you can find a list of officially supported plugins for the taskiq.
 
-* [Available brokers](./brokers.md)
-* [Available result backends](./result-backends.md)
-* [Available schedule sources](./scheduler-sources.md)
+- [Available brokers](./brokers.md)
+- [Available result backends](./result-backends.md)
+- [Available schedule sources](./schedule-sources.md)

docs/available-components/brokers.md

@@ -10,37 +10,38 @@ In this section we'll list officially supported brokers.
 
 This is a special broker for local development. It uses the same functions to execute tasks,
 but all tasks are executed locally in the current thread.
-By default it uses `InMemoryResultBackend` but this can be overiden.
-
+By default it uses `InMemoryResultBackend` but this can be overriden.
 
 ## ZeroMQBroker
 
-This broker uses [ZMQ](https://zeromq.org/) to comunicate between worker and client processes.
+This broker uses [ZMQ](https://zeromq.org/) to communicate between worker and client processes.
 It's suitable for small projects with only ONE worker process, because of the ZMQ architecture.
 
 It publishes messages on the local port. All worker processes are reading messages from this port.
 If you run many worker processes, all tasks will be executed `N` times, where `N` is the total number of worker processes.
 
 ::: danger Be careful!
 If you choose this type of broker, please run taskiq with `-w 1` parameter,
-otherwise you may encounter undefined behaviour.
+otherwise you may encounter undefined behavior.
 :::
 
-
 To run this broker please install the [pyzmq](https://pypi.org/project/pyzmq/) lib. Or you can taskiq with `zmq` extra.
 
 ::: tabs
 
 @tab Only PyZMQ
+
 ```bash
 pip install pyzmq
 ```
+
 @tab Taskiq with ZMQ
+
 ```bash
 pip install "taskiq[zmq]"
 ```
-:::
 
+:::
 
 ## Async shared broker and shared tasks
 
@@ -56,26 +57,28 @@ def my_task() -> bool:
 ```
 
 To kiq this task you have to options:
-* Explicitly define broker using kicker for this kiq;
-* Add default broker for all shared tasks.
+
+- Explicitly define broker using kicker for this kiq;
+- Add default broker for all shared tasks.
 
 ::: tabs
 
 @tab Defining default broker
+
 ```python
 from taskiq.brokers.shared_broker import async_shared_broker
 
 async_shared_broker.default_broker(broker)
 ```
 
 @tab using kicker
+
 ```python
 await my_task.kicker().with_broker(broker).kiq()
 ```
 
 :::
 
-
 ## AioPikaBroker (for RabbitMQ)
 
 This broker is not part of the core taskiq lib. You can install it as a separate package [taskiq-aio-pika](https://pypi.org/project/taskiq-aio-pika/).
@@ -86,7 +89,6 @@ pip install taskiq-aio-pika
 
 You can read more about parameters and abilities of this broker in [README.md](https://github.com/taskiq-python/taskiq-aio-pika).
 
-
 ## Redis broker
 
 This broker is not part of the core taskiq lib. You can install it as a separate package [taskiq-redis](https://pypi.org/project/taskiq-redis/).

docs/available-components/result-backends.md

@@ -6,10 +6,10 @@ order: 3
 
 Result backends are used to store execution results.
 This includes:
-* Captured logs;
-* return value;
-* Execution time in seconds.
 
+- Captured logs;
+- return value;
+- Execution time in seconds.
 
 ## DummyResultBackend
 
@@ -18,7 +18,6 @@ where you need actual results.
 
 This broker will always return `None` for any return_value. Please be careful.
 
-
 ## Redis result backend
 
 This result backend is not part of the core taskiq library. You can install it as a separate package [taskiq-redis](https://pypi.org/project/taskiq-redis/).

docs/available-components/schedule-sources.md

@@ -2,13 +2,11 @@
 order: 4
 ---
 
-
 # Available schedule sources
 
 These objects are used to fetch current schedule for tasks.
 Currently we have only one schedule source.
 
-
 ## LabelScheduleSource
 
 This source parses labels of tasks, and if it finds a `schedule` label, it considers this task as scheduled.
@@ -31,10 +29,11 @@ async def my_task():
 ```
 
 Parameters:
-* `cron` - crontab string when to run the task.
-* `args` - args to use, when invoking the task.
-* `kwargs` - key-word arguments to use when invoking the task.
-* `labels` - additional labels to use wehn invoking the task.
+
+- `cron` - crontab string when to run the task.
+- `args` - args to use, when invoking the task.
+- `kwargs` - key-word arguments to use when invoking the task.
+- `labels` - additional labels to use when invoking the task.
 
 Usage:
 
@@ -50,7 +49,6 @@ scheduler = TaskiqScheduler(
 )
 ```
 
-
 ::: warning Cool notice!
 
 In order to resolve all labels correctly, don't forget to import

docs/extending-taskiq/README.md

@@ -1,21 +1,19 @@
 ---
 dir:
-    order: 2
+  order: 2
 ---
 
 # Extending taskiq
 
-
 Taskiq is super extendable. The core library comes with different abstract classes.
 You can implement these abstract classes to extend functionality.
 
 All abstract classes can be found in `taskiq.abc` package.
 
-
 ## Contents:
 
-* [Brokers](./broker.md)
-* [Brokers](./broker.md)
-* [Result backends](./resutl-backend.md)
-* [CLI](./cli.md)
-* [Schedule sources](./schedule-sources.md)
+- [Brokers](./broker.md)
+- [Brokers](./broker.md)
+- [Result backends](./resutl-backend.md)
+- [CLI](./cli.md)
+- [Schedule sources](./schedule-sources.md)

docs/extending-taskiq/broker.md

@@ -17,6 +17,6 @@ For brokers, we have several conventions. It's good if your broker implements th
 These rules are optional, and it's ok if your broker doesn't implement them.
 
 1. If the message has the `delay` label with int or float number, this task's `execution` must be delayed
-    with the same number of seconds as in the delay label.
+   with the same number of seconds as in the delay label.
 2. If the message has the `priority` label, this message must be sent with priority. Tasks with
-    higher priorities are executed faster.
+   higher priorities are executed faster.

docs/extending-taskiq/cli.md

@@ -53,7 +53,6 @@ demo = "my_project.cmd:MyCommand"
 You can read more about entry points in [python documentation](https://packaging.python.org/en/latest/specifications/entry-points/).
 The subcommand name is the same as the name of the entry point you've created.
 
-
 ```bash
 $ taskiq demo --help
 usage: demo [-h] [--test TEST]

docs/extending-taskiq/resutl-backend.md

@@ -7,7 +7,6 @@ order: 3
 Result backends are used to store information about task execution.
 To create new `result_backend` you have to implement `taskiq.abc.result_backend.AsyncResultBackend` class.
 
-
 Here's a minimal example of a result backend:
 
 @[code python](../examples/extending/result_backend.py)