Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs and README with Badges and Fixes #17

Merged
merged 3 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
<img src="https://img.shields.io/pypi/pyversions/pyventus?color=0097a8" alt="Supported Python versions">
</a>

<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
<a href="https://pypi.org/project/pyventus">
<img src="https://img.shields.io/pypi/dm/pyventus.svg?color=0097a8" alt="Code style: black">
</a>

</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ hide:
<img src="https://img.shields.io/pypi/pyversions/pyventus?color=0097a8" alt="Supported Python versions">
</a>

<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
<a href="https://pypi.org/project/pyventus">
<img src="https://img.shields.io/pypi/dm/pyventus.svg?color=0097a8" alt="Code style: black">
</a>

</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ hide:
- Removed the base `Event` class due to improved event semantics and unnecessary redundancy.
- Renamed the `get_event_registry()` method of `EventLinker` to `get_registry()`.
- Renamed the `__event_registry` inner property of `EventLinker` to `__registry`.
- Renamed the `get_events_by_handler()` method of `EventLinker` to `get_event_handlers_by_events()`.
- Renamed the `get_events_by_handler()` method of `EventLinker` to `get_events_by_event_handler()`.
- Renamed the `get_handlers_by_events()` method of `EventLinker` to `get_event_handlers_by_events()`.
- Renamed the protected method `_executor_callback()` of the `ExecutorEventEmitter` to `_callback()`.
- Renamed the task name of `CeleryEventEmitter` from `_executor` to `pyventus_executor` to avoid collisions with other
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/emitters/asyncio/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# AsyncIO Event Emitter

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;Now that we've covered the base `EventEmitter` interface, let's examine one of its official
implementations: the `AsyncIOEventEmitter`.
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/emitters/celery/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Celery Event Emitter

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;The `CeleryEventEmitter` provides a powerful way to build event-driven applications that can handle high
volumes of work in a scalable and asynchronous manner.
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/emitters/executor/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Executor Event Emitter

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;The `ExecutorEventEmitter` leverages Python's `concurrent.futures` module to asynchronously execute
event emissions across threads or processes. This approach helps optimize performance for applications with
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/emitters/fastapi/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# FastAPI Event Emitter

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;The `FastAPIEventEmitter` provides a powerful way to build reactive [FastAPI](https://fastapi.tiangolo.com/)
applications using an event-driven architecture. It leverages FastAPI's asynchronous [BackgroundTasks](https://fastapi.tiangolo.com/reference/background/)
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/emitters/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Master the Event Emitter

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;In the previous tutorial, we learned how to link events with their event handlers using the
`EventLinker`. Now, let's dive into the process of dispatching events and triggering the associated callbacks.
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/emitters/rq/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# RQ Event Emitter

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;In the previous sections, we explored different event emitters, such as `AsyncIOEventEmitter` and
`ExecutorEventEmitter`. Now, let's dive into the `RQEventEmitter`, a powerful tool for handling events that
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/event-linker.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# The EventLinker Registry

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;Events are essential for building reactive applications with Pyventus. However, we need a way to connect
events to the code that should run in response. This is where the `EventLinker` comes in.
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/event.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Exploring Event Types

!!! warning "🏗️ Work in Progress"
This page is a work in progress.

<p style='text-align: justify;' markdown>
&emsp;&emsp;In this first tutorial, you'll learn about defining and handling events in Pyventus. Whether you're new
to event-driven programming or just getting started with the package, this guide will explain the key concepts.
Expand Down