Skip to content

Commit

Permalink
New Event Semantic and Major Improvements (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdapena authored Apr 9, 2024
1 parent 3956ed4 commit 1a7b89c
Show file tree
Hide file tree
Showing 46 changed files with 3,144 additions and 2,774 deletions.
528 changes: 327 additions & 201 deletions README.md

Large diffs are not rendered by default.

5 changes: 0 additions & 5 deletions docs/api/event.md

This file was deleted.

22 changes: 15 additions & 7 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,27 +66,27 @@ hide:
1. Create a virtual environment:

```console
python -m venv env
python -m venv venv
```

2. Activate the virtual environment:

=== "Linux, macOS"

```console
source ./env/bin/activate
source ./venv/bin/activate
```

=== "Windows PowerShell"

```console
.\env\Scripts\Activate.ps1
.\venv\Scripts\Activate.ps1
```

=== "Windows Bash"

```console
source ./env/Scripts/activate
source ./venv/Scripts/activate
```

3. Install development dependencies:
Expand Down Expand Up @@ -166,9 +166,17 @@ hide:
To begin working on the documentation in a development environment, simply execute the following command:
</p>

```console
hatch run docs:serve
```
=== "Manual"

```console
mkdocs serve --dev-addr localhost:8000
```

=== "Using Hatch"

```console
hatch run docs:serve
```

## Project Structure and Conventions

Expand Down
18 changes: 10 additions & 8 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,25 @@ hide:

<p style='text-align: justify;' markdown>
&emsp;&emsp;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](/pyventus/tutorials) or [API reference](/pyventus/api).
your project. For more detailed information on how to use this package, you can refer to the Pyventus
[Tutorials](/pyventus/tutorials) or [API Reference](/pyventus/api).
</p>

## Requirements

<p style='text-align: justify;' markdown>
&emsp;&emsp;Pyevents **only requires Python 3.10+** by default, which includes the [`AsyncIOEventEmitter`](/pyventus/tutorials/emitters/asyncio)
and the [`ExecutorEventEmitter`](/pyventus/tutorials/emitters/executor) with no additional dependencies. However,
your requirements may expand if you opt to use alternative built-in event emitter implementations.
&emsp;&emsp;By default, Pyventus' core functionalities and default event emitter implementations, such as the
[AsyncIO Event Emitter](/pyventus/tutorials/emitters/asyncio), and the [Executor Event Emitter](/pyventus/tutorials/emitters/executor),
**only require Python 3.10+** with no additional dependencies. However, these requirements may expand if you opt to
use alternative [*built-in*](#optional-dependencies) event emitter implementations.
</p>

## Installation

<p style='text-align: justify;' markdown>
&emsp;&emsp;Pyventus is available as a Python package and can be easily installed using `pip`. Open your terminal
and execute the following command to install it:
<p style='text-align: justify;'>
&emsp;&emsp;Pyventus is published as a <a href="https://pypi.org/project/pyventus/" target="_blank">Python package</a>
and can be installed using <code>pip</code>, ideally in a <a href="https://realpython.com/python-virtual-environments-a-primer/" target="_blank">virtual environment</a>
for proper dependency isolation. To get started, open up a terminal and install Pyventus with the following command:
</p>

```console
Expand Down
Binary file added docs/images/examples/practical-example-index.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1a7b89c

Please sign in to comment.