Skip to content

Commit

Permalink
Deployed 7fa691a to 0.2.1 with MkDocs 1.6.0 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ManiMozaffar committed Aug 16, 2024
1 parent 9457ed5 commit 730ae4e
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 13 deletions.
3 changes: 2 additions & 1 deletion 0.2.1/overview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1053,7 +1053,8 @@ <h3 id="8-callable">8. Callable<a class="headerlink" href="#8-callable" title="P
<h2 id="diagrams">Diagrams<a class="headerlink" href="#diagrams" title="Permanent link">&para;</a></h2>
<h3 id="ownership">Ownership<a class="headerlink" href="#ownership" title="Permanent link">&para;</a></h3>
<p><img alt="Ownership Diagram" src="../images/ownership-diagram.png" /></p>
<p>The diagram outlines the core structure of an AioClock application. It shows how the application organizes tasks using dependency injection and logical grouping. Tasks are defined with specific triggers and callables, making them modular and easy to manage. The flow between components, like including groups or using decorators, highlights the framework's flexibility in an asynchronous environment. Overall, the architecture is designed for clarity, promoting clean, organized code while allowing for scalable task management.</p>
<p>In AioClock, tasks are managed through clear ownership within groups, using dependency injection. Groups encapsulate related tasks, each with specific triggers and callables. The include_group() function integrates these groups into the AioClock application, while standalone tasks are managed with decorators like @aioclock.task. This structure ensures that tasks are organized, maintainable, and easy to scale, with each component having a defined responsibility within the application.
The dependency injection system in AioClock allows you to override a callable with another through the application interface, facilitating testing. For example, instead of returning a session from a PostgreSQL database with get_session, you can override it to use get_sqlite_session, which provides a SQLite session instead. This flexibility makes it easier to swap out components for testing or other purposes without changing the core logic.</p>
<h3 id="aioclock-lifecycle">Aioclock LifeCycle<a class="headerlink" href="#aioclock-lifecycle" title="Permanent link">&para;</a></h3>
<p><img alt="Aioclock LifeCycle" src="../images/lifecycle-diagram.png" /></p>
<p>This diagram shows the lifecycle of an AioClock application. It starts with the app.serve() call, which gathers all tasks and groups. The application then checks for startup tasks, runs them, and proceeds to other tasks. If a shutdown task is detected, it's executed before the application gracefully exits. If no shutdown tasks are present, the application simply exits. The diagram ensures a clear, step-by-step process for task management within the AioClock framework, ensuring tasks are executed in the proper order.</p>
Expand Down
2 changes: 1 addition & 1 deletion 0.2.1/search/search_index.json

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions 0.2.1/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,57 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/alternative/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/overview/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/api/external_api/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/api/getting_started/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/api/plugin/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/api/task/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/api/triggers/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/examples/brokers/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/examples/fastapi/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ManiMozaffar.github.io/aioclock/latest/images/</loc>
<lastmod>2024-08-15</lastmod>
<lastmod>2024-08-16</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified 0.2.1/sitemap.xml.gz
Binary file not shown.

0 comments on commit 730ae4e

Please sign in to comment.