diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7673b83 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,136 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org + +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html + +[Mozilla CoC]: https://github.com/mozilla/diversity + +[FAQ]: https://www.contributor-covenant.org/faq + +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..23b7ca0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1 @@ +Please read the [Contributing](https://mdapena.github.io/pyventus/contributing/) guidelines in the documentation site. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from .github/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/SECURITY.md b/.github/SECURITY.md similarity index 100% rename from SECURITY.md rename to .github/SECURITY.md diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 910d650..8ab6546 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,4 +1,5 @@ -name: Deploy Docs +name: Docs + on: push: branches: @@ -13,6 +14,8 @@ jobs: steps: - name: Checkout code uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Configure Git Credentials run: | @@ -20,7 +23,7 @@ jobs: git config user.email 41898282+github-actions[bot]@users.noreply.github.com - uses: actions/setup-python@v4 with: - python-version: 3.x + python-version: "3.10" - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV - uses: actions/cache@v3 with: @@ -28,5 +31,5 @@ jobs: path: .cache restore-keys: | mkdocs-material- - - run: pip install mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin + - run: pip install . mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin mkdocs-git-authors-plugin - run: mkdocs gh-deploy --force diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml new file mode 100644 index 0000000..7d82129 --- /dev/null +++ b/.github/workflows/publish-to-pypi.yml @@ -0,0 +1,55 @@ +name: PyPI + +on: + release: + types: + - created + +jobs: + build: + name: Build distribution 📦 + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.x" + + - name: Install pypa/build + run: python -m pip install build --user + + - name: Build a binary wheel and a source tarball + run: python -m build + + - name: Store the distribution packages + uses: actions/upload-artifact@v3 + with: + name: python-package-distributions + path: dist/ + + publish-to-pypi: + name: Publish Python 🐍 distribution 📦 to PyPI + needs: + - build + runs-on: ubuntu-latest + + environment: + name: pypi + url: https://pypi.org/p/pyventus + + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing + + steps: + - name: Download all the dists + uses: actions/download-artifact@v3 + with: + name: python-package-distributions + path: dist/ + + - name: Publish distribution 📦 to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/.github/workflows/tests.yml b/.github/workflows/run-tests.yml similarity index 100% rename from .github/workflows/tests.yml rename to .github/workflows/run-tests.yml diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..97acd5f --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,26 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: Pyventus +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Manuel + family-names: Da Pena + email: dapensoft@gmail.com +repository-code: 'https://github.com/mdapena/pyventus' +url: 'https://mdapena.github.io/pyventus/' +abstract: >- + A modern and robust Python package for event-driven + programming. Define, emit, and orchestrate events with + ease using customizable event emitters and flexible + responses. +keywords: + - events + - event-emitter + - event-handler + - event-linker +license: MIT diff --git a/README.md b/README.md index d7467a3..908bc8c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,41 @@

- Pyventus + Pyventus


+

+ + + Tests + + + + Docs + + + + Package version + + + + Supported Python versions + + + + Code style: black + + +

+ +
+ + --- -**Documentation**: https://github.com/mdapena/pyventus +**Documentation**: https://mdapena.github.io/pyventus **Source Code**: https://github.com/mdapena/pyventus @@ -410,7 +437,7 @@ event_emitter.emit("StringEvent")

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

@@ -420,6 +447,6 @@ event_emitter.emit("StringEvent")

  Pyventus is distributed as open source software and is released under the MIT License. - You can view the full text of the license in the LICENSE file located in the Pyventus repository. + You can view the full text of the license in the LICENSE file located in the Pyventus repository.

diff --git a/docs/api/emitters/asyncio-event-emitter.md b/docs/api/emitters/asyncio-event-emitter.md index cfd526a..404a2b7 100644 --- a/docs/api/emitters/asyncio-event-emitter.md +++ b/docs/api/emitters/asyncio-event-emitter.md @@ -1,3 +1,5 @@ # `AsyncIOEventEmitter` class ::: pyventus.AsyncIOEventEmitter + +
diff --git a/docs/api/emitters/executor-event-emitter.md b/docs/api/emitters/executor-event-emitter.md index 3469f7f..a6f1589 100644 --- a/docs/api/emitters/executor-event-emitter.md +++ b/docs/api/emitters/executor-event-emitter.md @@ -1,3 +1,5 @@ # `ExecutorEventEmitter` class ::: pyventus.ExecutorEventEmitter + +
diff --git a/docs/api/emitters/index.md b/docs/api/emitters/index.md index ca21656..7672246 100644 --- a/docs/api/emitters/index.md +++ b/docs/api/emitters/index.md @@ -6,3 +6,5 @@ - __init__ - emit - _execute + +
diff --git a/docs/api/emitters/rq-event-emitter.md b/docs/api/emitters/rq-event-emitter.md index 3e5f718..7a0e4fa 100644 --- a/docs/api/emitters/rq-event-emitter.md +++ b/docs/api/emitters/rq-event-emitter.md @@ -1,3 +1,5 @@ # `RQEventEmitter` class ::: pyventus.RQEventEmitter + +
diff --git a/docs/api/event-handler.md b/docs/api/event-handler.md index 202f7af..dfc4673 100644 --- a/docs/api/event-handler.md +++ b/docs/api/event-handler.md @@ -1,3 +1,5 @@ # `EventHandler` class ::: pyventus.EventHandler + +
diff --git a/docs/api/event-linker.md b/docs/api/event-linker.md index 64faf5e..ffe1f6d 100644 --- a/docs/api/event-linker.md +++ b/docs/api/event-linker.md @@ -1,3 +1,5 @@ # `EventLinker` class ::: pyventus.EventLinker + +
diff --git a/docs/api/event.md b/docs/api/event.md index 4239267..e09b02a 100644 --- a/docs/api/event.md +++ b/docs/api/event.md @@ -1,4 +1,5 @@ # `Event` dataclass ::: pyventus.Event - \ No newline at end of file + +
diff --git a/docs/contributing.md b/docs/contributing.md index da2b4af..c47cfd1 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -280,7 +280,7 @@ hatch run tests:all ## Code of Conduct

-   This project and everyone participating in it is governed by the [Pyventus Code of Conduct](https://github.com/mdapena/pyventus/CODE_OF_CONDUCT.md). +   This project and everyone participating in it is governed by the [Pyventus Code of Conduct](https://github.com/mdapena/pyventus/.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior.

@@ -291,3 +291,5 @@ hatch run tests:all and greatly appreciated. If you have any questions or need further clarification, please don't hesitate to reach out. We look forward to collaborating with you to enhance this project!

+ +
diff --git a/docs/getting-started.md b/docs/getting-started.md index ee0000a..4a67bf4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -13,14 +13,14 @@ hide:

  Welcome to the Getting Started section! This guide will help you install and configure Pyventus in your project. For more detailed instructions on how to use this package, you can refer to the Pyventus - [tutorials](/tutorials) or [API reference](/api). + [tutorials](/pyventus/tutorials) or [API reference](/pyventus/api).

## Requirements

-   Pyevents **only requires Python 3.10+** by default, which includes the [`AsyncIOEventEmitter`](/tutorials/emitters/asyncio-event-emitter) - and the [`ExecutorEventEmitter`](/tutorials/emitters/executor-event-emitter) with no additional dependencies. +   Pyevents **only requires Python 3.10+** by default, which includes the [`AsyncIOEventEmitter`](/pyventus/tutorials/emitters/asyncio-event-emitter) + and the [`ExecutorEventEmitter`](/pyventus/tutorials/emitters/executor-event-emitter) with no additional dependencies. However, your requirements may expand if you opt to use alternative built-in event emitter implementations.

@@ -45,8 +45,9 @@ pip install pyventus + +
diff --git a/docs/index.md b/docs/index.md index 84ab928..410ed35 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,15 +8,44 @@ hide: .md-content .md-content__inner.md-typeset::before { height: 0; } +
+

Pyventus

+
+ +

+ + + Tests + + + + Docs + + + + Package version + + + + Supported Python versions + + + + Code style: black + + +

+ + --- -**Documentation**: https://github.com/mdapena/pyventus +**Documentation**: https://mdapena.github.io/pyventus **Source Code**: https://github.com/mdapena/pyventus @@ -391,9 +420,7 @@ Open your browser at http: see the JSON response as: ```JSON -{ - "message": "Console print triggered!" -} +{ "message": "Console print triggered!" } ``` You'll also be able to see the outputs of the event emitters in the console logs as: @@ -530,6 +557,7 @@ Hello, AsyncIOEventEmitter!   Pyventus continuously adapts to support developers across technological and programming domains. Its aim is to remain at the forefront of event-driven design. Future development may introduce new official event emitters, expanding compatibility with different technologies through seamless integration. +

  Current default emitters provide reliable out-of-the-box capabilities for common use cases. They @@ -541,7 +569,7 @@ Hello, AsyncIOEventEmitter!

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

@@ -558,7 +586,7 @@ Hello, AsyncIOEventEmitter! ---

- [:material-star-outline: Getting Started :material-star-outline:](/getting-started){ .md-button } + [:material-star-outline: Getting Started :material-star-outline:](/pyventus/getting-started/){ .md-button }

--- @@ -567,6 +595,6 @@ Hello, AsyncIOEventEmitter!

  Pyventus is distributed as open source software and is released under the MIT License. - You can view the full text of the license in the LICENSE file located in the Pyventus repository. + You can view the full text of the license in the LICENSE file located in the Pyventus repository.

diff --git a/docs/release-notes.md b/docs/release-notes.md index e0257d2..d5b8047 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,3 +2,46 @@ hide: - navigation --- + +[//]: # (--------------------------------------------------------------------------------------------------------------) + +## v0.2.0 + +### What's Changed + +- **GitHub Actions:** This release introduces the "publish to PyPI" workflow, automating the uploading of package builds + when new releases are created. Additionally, it includes minor bug fixes and refactoring in the "deploy-docs" and " + run-tests" workflows. +- **Academic Citations:** To facilitate academic citations, a CITATION.cff file has been added in this release. +- **Code of conduct:** A code of conduct has been added to the project using + the [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). +- **Project Badges:** Badges have been added to the main page of the documentation as well as the readme file. +- **git-authors mkdocs material:** The mkdocs.yml file has been updated to include the "git-authors" plugin, which lists + the names of documentation contributors on their respective pages. +- **Documentation Improvements:** Fixed issues with relative links in the documentation. + +[//]: # (--------------------------------------------------------------------------------------------------------------) + +## v0.1.0 + +### What's Changed + +- **Initial implementation of Pyventus by [@mdapena](https://github.com/mdapena) + in [#2](https://github.com/mdapena/pyventus/pull/2):** This release + introduces Pyventus 0.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. + +[//]: # (--------------------------------------------------------------------------------------------------------------) + +
diff --git a/docs/tutorials/emitters/asyncio-event-emitter.md b/docs/tutorials/emitters/asyncio-event-emitter.md index ed61c16..9b7c6c6 100644 --- a/docs/tutorials/emitters/asyncio-event-emitter.md +++ b/docs/tutorials/emitters/asyncio-event-emitter.md @@ -127,4 +127,6 @@ It leverages `AsyncIO` to concurrently run callbacks in sync and async contexts   By understanding these concepts, you can effectively utilize the `AsyncIOEventEmitter` to emit events in both synchronous and asynchronous contexts, benefiting from the concurrency features provided by the `AsyncIO` framework. -

\ No newline at end of file +

+ +
diff --git a/docs/tutorials/emitters/executor-event-emitter.md b/docs/tutorials/emitters/executor-event-emitter.md index 5eaec56..9e72d67 100644 --- a/docs/tutorials/emitters/executor-event-emitter.md +++ b/docs/tutorials/emitters/executor-event-emitter.md @@ -178,3 +178,5 @@ optimize your applications to take full advantage of multicore systems through balanced workload distribution. Proper use of this approach can significantly improve performance.

+ +
diff --git a/docs/tutorials/emitters/index.md b/docs/tutorials/emitters/index.md index b28d76a..c43ada5 100644 --- a/docs/tutorials/emitters/index.md +++ b/docs/tutorials/emitters/index.md @@ -37,7 +37,7 @@   Pyventus includes several build-in event emitters by default. For instance, the `AsyncIOEventEmitter` leverages the `AsyncIO` framework to handle the execution of event handler callbacks, while the `RQEventEmitter` utilizes Redis Queue pub/sub system with workers to manage event handlers. To explore the available event emitters, - refer to the [Pyventus documentation](/getting-started). + refer to the [Pyventus documentation](/pyventus/getting-started).

!!! info "Driving Innovation Through Collaboration" @@ -306,3 +306,5 @@ event_emitter.emit('Hello', "Pyventus") the process of creating custom event emitters. We also covered the usage of custom event linkers, best practices for using the `EventEmitter`, and the debug mode options provided by Pyventus.

+ +
diff --git a/docs/tutorials/emitters/rq-event-emitter.md b/docs/tutorials/emitters/rq-event-emitter.md index 475d880..86d25ce 100644 --- a/docs/tutorials/emitters/rq-event-emitter.md +++ b/docs/tutorials/emitters/rq-event-emitter.md @@ -46,7 +46,7 @@ parallel execution.
  1. **Install Python RQ:** -Before proceeding, make sure you have installed the [optional Python RQ dependency](/getting-started/#optional-dependencies). +Before proceeding, make sure you have installed the [optional Python RQ dependency](/pyventus/getting-started/#optional-dependencies).
  2. **Python RQ worker configuration:** @@ -190,3 +190,4 @@ This distributed model scales efficiently regardless of workload volume. +
    diff --git a/docs/tutorials/event-linker.md b/docs/tutorials/event-linker.md index 5069850..9afd202 100644 --- a/docs/tutorials/event-linker.md +++ b/docs/tutorials/event-linker.md @@ -594,3 +594,5 @@ Subscribe/unsubscribe as needed using various approaches.
    3. + +
    diff --git a/docs/tutorials/event.md b/docs/tutorials/event.md index 3a4e95a..c16bad0 100644 --- a/docs/tutorials/event.md +++ b/docs/tutorials/event.md @@ -370,3 +370,5 @@ event_emitter.emit(ValueError('Value Error!')) custom or built-in Pyventus implementation of your choice. For more information on available options, consult the official documentation.

    + +
    diff --git a/mkdocs.yml b/mkdocs.yml index 1d6b7c3..8ff2324 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,20 @@ +# Project information site_name: Pyventus -site_description: A modern and robust Python package for event-driven programming. Define, emit, and orchestrate events with ease using customizable event emitters and flexible responses. +site_url: https://mdapena.github.io/pyventus/ +site_author: Manuel Da Pena +site_description: >- + A modern and robust Python package for event-driven programming. Define, emit, and + orchestrate events with ease using customizable event emitters and flexible responses. +# Repository +repo_name: mdapena/pyventus +repo_url: https://github.com/mdapena/pyventus + +# Copyright +copyright: | + Copyright © 2023 Manuel Da Pena + +# Configuration theme: name: material language: en @@ -36,35 +50,25 @@ theme: - content.tooltips - content.code.annotate -repo_name: mdapena/pyventus -repo_url: https://github.com/mdapena/pyventus - -markdown_extensions: - - attr_list - - md_in_html - - pymdownx.arithmatex: - generic: true - - pymdownx.highlight: - anchor_linenums: true - - pymdownx.inlinehilite - - pymdownx.snippets: - base_path: - - !relative $docs_dir - - admonition - - footnotes - - pymdownx.details - - pymdownx.superfences - - pymdownx.mark - - abbr - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - - pymdownx.tabbed: - alternate_style: true +# Customization +extra: + social: + - icon: fontawesome/brands/linkedin + link: https://ve.linkedin.com/in/manuel-da-pena/en + - icon: fontawesome/brands/github + link: https://github.com/mdapena +# Plugins plugins: - search + - git-authors: + exclude: + - api/index.md + - tutorials/index.md + - about.md + - index.md - git-revision-date-localized: + type: timeago exclude: - api/index.md - tutorials/index.md @@ -88,7 +92,31 @@ plugins: show_signature_annotations: true show_category_heading: true +# Extensions +markdown_extensions: + - attr_list + - md_in_html + - pymdownx.arithmatex: + generic: true + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets: + base_path: + - !relative $docs_dir + - admonition + - footnotes + - pymdownx.details + - pymdownx.superfences + - pymdownx.mark + - abbr + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.tabbed: + alternate_style: true +# Page tree nav: - Pyventus: index.md - Getting Started: getting-started.md @@ -113,13 +141,3 @@ nav: - RQ Event Emitter: api/emitters/rq-event-emitter.md - Contributing: contributing.md - Release Notes: release-notes.md - -extra: - social: - - icon: fontawesome/brands/linkedin - link: https://ve.linkedin.com/in/manuel-da-pena/en - - icon: fontawesome/brands/github - link: https://github.com/mdapena - -copyright: | - Copyright © 2023 Manuel Da Pena diff --git a/pyproject.toml b/pyproject.toml index 67cac47..72317a3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,8 @@ authors = [ { name = "Manuel Da Pena", email = "dapensoft@gmail.com" }, ] classifiers = [ + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", @@ -28,7 +30,7 @@ classifiers = [ "Topic :: Software Development", "Typing :: Typed", ] -keywords = [] +keywords = ["events", "event emitters", "event handlers", "event linkers"] # ------------------------------------------------------------------ # | Project Dependencies | @@ -142,6 +144,7 @@ dependencies = [ "mkdocs-material>=9.4.0", "mkdocstrings[python]>=0.24.0", "mkdocs-git-revision-date-localized-plugin>=1.2.1", + "mkdocs-git-authors-plugin>=0.7.2", ] [tool.hatch.envs.docs.scripts] build = "mkdocs build --clean --strict" diff --git a/src/pyventus/__init__.py b/src/pyventus/__init__.py index 2749ab0..0aa3a3b 100644 --- a/src/pyventus/__init__.py +++ b/src/pyventus/__init__.py @@ -3,7 +3,7 @@ customizable event emitters and flexible responses. """ -__version__ = "0.1.0" +__version__ = "0.2.0" from .core.exceptions import PyventusException from .emitters import EventEmitter, EmittableEventType