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 function handle_greet_event(), which will print 'Hello, W
  • Instantiating an Event Emitter: After that, and in order to trigger our event, we needed to create an instance of the event emitter class. While -AsyncIOEventEmitter was utilized, any built-in -or custom implementation could be employed. +AsyncIOEventEmitter was utilized, any built-in or custom implementation could be employed.
  • @@ -200,8 +199,7 @@ Finally, by using the 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 division

      Pyventus 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 @@

    404 - Page Not Found

    - 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.

    diff --git a/docs/contributing.md b/docs/contributing.md index 63f35a5..c3dfbac 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -69,25 +69,25 @@ hide: python -m venv venv ``` -2. Activate the virtual environment: +2. Activate the environment with: - === "Linux, macOS" - - ```console - source ./venv/bin/activate - ``` - - === "Windows PowerShell" - - ```console - .\venv\Scripts\Activate.ps1 - ``` - - === "Windows Bash" - - ```console - source ./venv/Scripts/activate - ``` + === ":material-apple: macOS" + + ``` sh + . venv/bin/activate + ``` + + === ":fontawesome-brands-windows: Windows" + + ``` sh + . venv/Scripts/activate + ``` + + === ":material-linux: Linux" + + ``` sh + . venv/bin/activate + ``` 3. Install development dependencies: @@ -285,6 +285,12 @@ hatch run tests:all hatch run +py=3.12 tests:all ``` + === "Python 3.13" + + ```console + hatch run +py=3.13 tests:all + ``` + !!! warning "Troubleshooting Hatch Environment Errors"

    diff --git a/docs/index.md b/docs/index.md index 017c37e..c15d73c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,8 +47,8 @@ hide: Supported Python versions - - Code style: black + + Code style: black

    diff --git a/docs/release-notes.md b/docs/release-notes.md index 57f0ff0..b37304b 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -12,6 +12,33 @@ hide: [//]: # (--------------------------------------------------------------------------------------------------------------) +## [v0.6.0](https://github.com/mdapena/pyventus/releases/tag/0.6.0) October 19, 2024 { id="0.6.0" } + +
    + +##### Added + +- Added support for Python `3.13`, ensuring compatibility with the latest features and improvements. +- Added `mike` package integration to `mkdocs-material` for documentation versioning. This allows users to access + previous documentation alongside new changes, ensuring that legacy content remains intact for reference. Additionally, + a new `dev` documentation has been introduced to showcase the current development of the package, including unreleased + features and updates. + +##### Changed + +- Updated documentation links from absolute to relative paths to prevent broken links and avoid redirecting users to + incorrect documentation versions, ensuring consistent navigation throughout the docs. +- Upgraded the `download-artifact` and `cache` actions to `v4` in the `publish-to-pypi.yml` workflow. +- Updated the `deploy-docs.yml` workflow to deploy both `dev` and versioned documentation using `mike`'s CLI commands. + +##### Fixed + +- Fixed broken links to non-versioned documentation by adding a custom `404.html` page to `gh-pages`, which redirects + users to the first version of the documentation when no version is specified, or to a new custom 404 page with helpful + suggestions. + +[//]: # (--------------------------------------------------------------------------------------------------------------) + ## [v0.5.0](https://github.com/mdapena/pyventus/releases/tag/0.5.0) April 9, 2024 { id="0.5.0" }
    diff --git a/src/pyventus/__init__.py b/src/pyventus/__init__.py index 49ba031..367e268 100644 --- a/src/pyventus/__init__.py +++ b/src/pyventus/__init__.py @@ -1,6 +1,6 @@ """A powerful Python package for event-driven programming; define, emit, and orchestrate events with ease.""" -__version__ = "0.5.0" +__version__ = "0.6.0" from .core.exceptions import PyventusException from .emitters import EventEmitter, EmittableEventType