Pyventus

Release Note

Added

- Introduced the `publish to PyPI` workflow, automating the uploading of package builds when new releases are created.
- Added the `mkdocs-git-authors` plugin to display git authors of a markdown page in the documentation.
- Added badges to the main page of the documentation as well as the readme file.
- Added a code of conduct for the project, using the [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
- Included a `CITATION.cff` file to facilitate academic citations.

Changed

- Renamed the `tests.yml` workflow to `run-tests.yml`.
- Updated the `deploy-docs.yml` workflow with the `mkdocs-git-authors` plugin dependency.
- Modified the `mkdocs.yml` config file by adding the `site_url` and `site_author` properties.
- Updated the `pyproject.toml` file with the `mkdocs-git-authors` plugin dependency and python package keywords.

Fixed

- Fixed the python version in the `deploy-docs.yml` workflow.
- Resolved issues with relative links in the documentation.

Changelog

- Full Changelog: https://github.com/mdapena/pyventus/compare/0.1.0...0.2.0
- Contributors: mdapena

Initial Implementation

  This release introduces Pyventus v0.1.0, a modern and robust Python package for event-driven programming. Pyventus provides developers with a comprehensive suite of tools and utilities to define, emit, and orchestrate events. It empowers developers to build scalable, extensible, and loosely-coupled event-driven applications.

- **Implementation Details:** The first implementation includes all the core functionalities of the package, encompassing events, event linkers, event emitters, event handlers, and more.
- **Testing and Coverage:** This release includes a test suite that verifies the correctness of the package implementation. It also integrates code coverage, achieving 100% test coverage. The tests are configured to run automatically via GitHub Actions on both push and pull requests to the master branch.
- **Formatter and Lint Configuration:** A formatter and lint configuration have been added to the project. This ensures consistent code style, maintainability, and adherence to the established coding standards defined in the project documentation.
- **Documentation:** Additionally, this release includes comprehensive documentation for the package. The documentation covers the main page, a detailed getting started guide, tutorials, API reference, and release notes.

Changelog

- Full Changelog: [v0.1.0](https://github.com/mdapena/pyventus/commits/0.1.0)
- Contributors: mdapena