Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
wonkybream committed Nov 29, 2024
1 parent f29bd6f commit b60e722
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Pirssi is a Python client for using IRC as a message broker.

Code itself does not require any external libraries, only tests and static analysis require installation of `requirements.txt`
Code itself does not require any external libraries, only static analysis require installation of `requirements.txt`.

## How this plays out

Expand Down Expand Up @@ -41,7 +41,7 @@ The default channel is `#pirssi-queue`.

At first start the consumer.
```shell
$ python example.py consumer
python example.py consumer
```

And wait for the consumer to connect into channel. the consumer produces a log line something like this.
Expand All @@ -51,7 +51,7 @@ And wait for the consumer to connect into channel. the consumer produces a log l

Then start the publisher.
```shell
$ python example.py publisher
python example.py publisher
```

The publisher publishes few messages and then quits, the consumer receives those messages and forwards them to a handler which prints them out.
Expand All @@ -74,18 +74,15 @@ Project uses Python unittest as a testing framework, flake8 as style checker and

Install test requirements.
```shell
$ pip install -r requirements.txt
pip install -r requirements.txt
```

Run tests using following command in the project path.
```shell
$ python -m unittest -v
python -m unittest -v
```

And finally run static analysis.
Or run everything at once.
```shell
$ black ./
$ isort ./
$ mypy ./
$ flake8
./scripts/precommit.sh
```

0 comments on commit b60e722

Please sign in to comment.