From 13881fab57d48ab15d66d534b527fb9f5e2e96c1 Mon Sep 17 00:00:00 2001 From: Moul <moul@moul.re> Date: Thu, 6 May 2021 23:16:57 +0200 Subject: [PATCH] [doc] #160: Document examples usage from Python interpreter --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f1e74b4b..dac36b37 100644 --- a/README.md +++ b/README.md @@ -80,12 +80,28 @@ Black, the formatting tool, requires Python 3.6 or higher. poetry install --no-dev ``` -* Have a look at the examples folder -* Run examples from parent folder +### Examples +* Have a look at the `examples` folder +* Run examples from parent folder directly ```bash 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 +await examples.request_data_async() +``` + * Before submitting a merge requests, please check the static typing and tests. * Install dev dependencies -- GitLab