Skip to content
Snippets Groups Projects
Commit 2cce4efa authored by Moul's avatar Moul
Browse files

[doc] #160: Document examples usage from Python interpreter

parent 3ec03df3
No related branches found
No related tags found
No related merge requests found
Pipeline #12133 passed
...@@ -80,12 +80,29 @@ Black, the formatting tool, requires Python 3.6 or higher. ...@@ -80,12 +80,29 @@ Black, the formatting tool, requires Python 3.6 or higher.
poetry install --no-dev poetry install --no-dev
``` ```
* Have a look at the examples folder ### Examples
* Run examples from parent folder * Have a look at the `examples` folder
* Run examples from parent folder directly
```bash ```bash
poetry run python examples/request_data.py poetry run python examples/request_data.py
``` ```
Or from Python interpreter:
```bash
poetry run python
>>> import examples
>>> help(examples)
>>> examples.create_public_key()
```
`request_data_async` requires [`aioconsole`](https://pypi.org/project/aioconsole/):
```bash
poetry add aioconsole --dev
poetry run apython
import examples
await examples.request_data_async()
```
* Before submitting a merge requests, please check the static typing and tests. * Before submitting a merge requests, please check the static typing and tests.
* Install dev dependencies * Install dev dependencies
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment