Merge branch 'develop' into 'idle-tasks'

Author: Anton

.flake8

@@ -103,6 +103,8 @@ ignore =
   F403,
   ; Found wrong metadata variable
   WPS410,
+  ; Found commented out cod
+  E800,
 
 per-file-ignores =
   ; all tests

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: taskiq-python
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

docs/.vuepress/config.ts

@@ -5,7 +5,7 @@ import { hopeTheme } from "vuepress-theme-hope";
 export default defineUserConfig({
   lang: "en-US",
   title: "Taskiq",
-  description: "Distributed task queue with full async support",
+  description: "Async Distributed Task Manager",
   head: [
     [
       "meta",
@@ -31,6 +31,7 @@ export default defineUserConfig({
     backToTop: false,
 
     plugins: {
+      readingTime: false,
       copyCode: {
         showInMobile: true,
       },

docs/README.md

@@ -1,5 +1,5 @@
 ---
-title: Home
+title: Task manager for asyncio
 home: true
 heroImage: logo.svg
 heroAlt: logo
@@ -28,6 +28,15 @@ features:
 footer: MIT Licensed | Copyright© 2022-2023
 ---
 
+## What is taskiq in a nutshell
+
+Consider taskiq as an asyncio celery implementation. It uses almost the same patterns, but it's more modern
+and flexible.
+
+It's not a drop-in replacement for any other task manager. It has a different ecosystem of libraries and a different set of features.
+Also, it doesn't work for synchronous projects. You won't be able to send tasks synchronously.
+
+
 ## Installation
 
 You can install taskiq with pip or your favorite dependency manager:

docs/available-components/README.md

@@ -1,7 +1,7 @@
 ---
 order: 1
 dir:
-  order: 3
+  order: 4
 ---
 
 # Available components

docs/available-components/brokers.md

@@ -10,7 +10,7 @@ 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 overriden.
+By default it uses `InMemoryResultBackend` but this can be overridden.
 
 ## ZeroMQBroker
 

docs/examples/extending/result_backend.py

@@ -53,7 +53,7 @@ async def is_result_ready(
         Check if result exists.
 
         This function must check whether result
-        is available in your resul backend
+        is available in your result backend
         without fetching the result.
 
         :param task_id: id of a task.

docs/extending-taskiq/README.md

@@ -1,6 +1,6 @@
 ---
 dir:
-  order: 2
+  order: 3
 ---
 
 # Extending taskiq

docs/framework_integrations/README.md

@@ -0,0 +1,13 @@
+---
+order: 1
+dir:
+  order: 2
+---
+
+# Framework integrations
+
+Taskiq is meant to be simple and adaptive. That's why we try to add different integrations to make development with taskiq and your favorite framework easy and fun!
+
+Integrations with frameworks add two things:
+1. Startup and Shutdown events;
+1. Dependencies to use in your handler.

docs/framework_integrations/taskiq-with-aiohttp.md

@@ -0,0 +1,126 @@
+---
+order: 2
+---
+
+# Taskiq + AioHTTP
+
+AioHTTP is a framework for building robust applications. We created several libraries to make the experience with AioHTTP even better.
+
+# Dependency inecjeciton for AioHTTP
+
+We created a library [aiohttp-deps](https://pypi.org/project/aiohttp-deps/) to add FastAPI-like dependency injection in AioHTTP.
+
+To install it, simply run:
+
+```python
+pip install "aiohttp-deps"
+```
+
+After the installation, please add startup event to your application to initialize dependencies context.
+
+```python
+from aiohttp import web
+import aiohttp_deps
+
+
+app = web.Application()
+
+# This startup event makes all the magic happen.
+# It parses current handlers and create dependency graphs for them.
+app.on_startup.append(aiohttp_deps.init)
+
+web.run_app(app)
+```
+
+You can read more about dependency injection and available dependencies in the project's [README.md](https://github.com/taskiq-python/aiohttp-deps).
+
+
+
+## Adding taskiq integration
+
+We highly recommend using aiohttp with aiohttp-deps because it allows us to reuse the same dependencies for your handlers and tasks. First of all, you should install the [taskiq-aiohttp](https://pypi.org/project/taskiq-aiohttp/) library.
+
+```python
+pip install "taskiq-aiohttp"
+```
+
+After the installation is complete, add an initialization function call to your broker's main file so it becomes something like this:
+
+```python
+import taskiq_aiohttp
+
+broker = MyBroker()
+
+# The second argument is a path to web.Application variable.
+# Also you can provide here a factory function that takes no
+# arguments and returns an application. This function can be async.
+taskiq_aiohttp.init(broker, "my_project.main:app")
+```
+
+From this point, you'll be able to reuse the same dependencies as with `aiohttp-deps`.
+Let's take a look at this function:
+
+```python
+from aiohttp import web
+from taskiq import TaskiqDepends
+from my_project.tkq import broker
+
+@broker.task
+async def my_task(app: web.Application = TaskiqDepends()):
+    ...
+
+```
+
+In this example, we depend on the current application. We can use its state in a current task or any other dependency. We can take db_pool from your application's state, which is the same pool, as the one you've created on AiohTTP's startup.
+But this application is only a mock of your application. It has correct types and all your variables that you filled on startup, but it doesn't handle any request.
+This integration adds two main dependencies:
+* web.Application - current application.
+* web.Request - mocked request. This request only exists to be able to use the same dependencies.
+
+You can find more detailed examples in the [examples repo](https://github.com/taskiq-python/examples).
+
+## Testing
+
+Writing tests for AioHTTP with taskiq is as easy as writing tests for the aiohttp application. The only difference is that, if you want to use InMemoryBroker, then you need to add context for dependency injection. It's easier to call `populate_context` when creating a `test_client` fixture.
+
+```python
+import taskiq_aiohttp
+
+@pytest.fixture
+async def test_client(
+    app: web.Application,
+) -> AsyncGenerator[TestClient, None]:
+    """
+    Create a test client.
+
+    This function creates a TestServer
+    and a test client for the application.
+
+    Also this fixture populates context
+    with needed variables.
+
+    :param app: current application.
+    :yield: ready to use client.
+    """
+    loop = asyncio.get_running_loop()
+    server = TestServer(app)
+    client = TestClient(server, loop=loop)
+
+    await client.start_server()
+
+    # This is important part.
+    # Since InMemoryBroker doesn't
+    # run as a worker process, we have to populate
+    # broker's context by hand.
+    taskiq_aiohttp.populate_context(
+        broker=broker,
+        server=server.runner.server,
+        app=app,
+        loop=loop,
+    )
+
+    yield client
+
+    broker.custom_dependency_context = {}
+    await client.close()
+```