From e31bf6d5a6702a97fb2838494bb83b2133a4fc2b Mon Sep 17 00:00:00 2001 From: Manuel Da Pena <65864237+mdapena@users.noreply.github.com> Date: Sat, 19 Oct 2024 09:28:17 -0400 Subject: [PATCH] Release notes for `v0.6.0` and documentation updates (#23) * Improve 404 error page message * Update contributing with new supported python version * Release version 0.6.0 * Update links in README file to new release * Tweak index and contributing docs --- README.md | 19 ++++++++---------- docs/.overrides/404.html | 4 ++-- docs/contributing.md | 42 +++++++++++++++++++++++----------------- docs/index.md | 4 ++-- docs/release-notes.md | 27 ++++++++++++++++++++++++++ src/pyventus/__init__.py | 2 +- 6 files changed, 64 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 63daa46..a6514bf 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ pip install pyventus Pyventus by default relies on the Python standard library and requires Python 3.10 or higher with no additional dependencies. However, this package also includes alternative integrations to access additional features such as Redis Queue, Celery, and FastAPI. For more information on this matter, please refer to the - Optional Dependencies + Optional Dependencies section.
@@ -184,8 +184,7 @@ to the functionhandle_greet_event()
, which will print 'Hello, W
AsyncIOEventEmitter
was utilized, any built-in
-or custom implementation could be employed.
+AsyncIOEventEmitter
was utilized, any built-in or custom implementation could be employed.
emit()
method of the event emitter instance,
Having gained a clear understanding of the workflow showcased in the Hello, World!
example,
you are now well-equipped to explore more intricate event-driven scenarios and fully harness the capabilities of
Pyventus in your own projects. For a deep dive into the package's functionalities, you can refer to the
- Pyventus Tutorials or
- API.
+ Pyventus Tutorials or API.
[//]: # (--------------------------------------------------------------------------------------------------------------)
@@ -390,10 +388,9 @@ async def async_function(event_emitter: EventEmitter):
At its core, Pyventus utilizes a modular event emitter design that allows you to switch seamlessly - between different built-in - or custom event emitter implementations on the fly. Whether you opt for official emitters or decide to create your - custom ones, Pyventus allows you to tailor the behavior and capabilities of the event emitters to perfectly align - with your unique requirements. + between different built-in or custom event emitter implementations on the fly. Whether you opt for official emitters + or decide to create your custom ones, Pyventus allows you to tailor the behavior and capabilities of the event + emitters to perfectly align with your unique requirements.
### Swapping Event Emitter Implementations at Runtime @@ -453,7 +450,7 @@ class FastAPIEventEmitter(EventEmitter):In case you're interested in integrating Pyventus with FastAPI, you can refer to the official Pyventus - FastAPI Event Emitter + FastAPI Event Emitter implementation.
@@ -569,7 +566,7 @@ event_emitter.emit("DivisionEvent", a=1, b=2) # Example: Valid divisionPyventus is an open source project that welcomes community involvement. If you wish to contribute - additional event emitters, improvements, or bug fixes, please check the Contributing + additional event emitters, improvements, or bug fixes, please check the Contributing section for guidelines on collaborating. Together, we can further the possibilities of event-driven development.
diff --git a/docs/.overrides/404.html b/docs/.overrides/404.html index e687fc5..2c8c135 100644 --- a/docs/.overrides/404.html +++ b/docs/.overrides/404.html @@ -31,11 +31,11 @@- We're sorry, but the page at the path could not be found. + The requested URL was not found in this documentation.
- Try searching or go to Pyventus' homepage. + Try searching or go to Pyventus' home page.