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

readme: Remove need for Poetry to run examples

Still a discovery process which does and shall
not requires Poetry, unless editing the examples

Try to simplify the entry

Remove Poetry installation for the usage, discovery
not DuniterPy development itself
parent 90b9f1d8
No related branches found
No related tags found
1 merge request!188Clarify readme and contributing documentation (#105, #155)
Pipeline #32619 passed
...@@ -58,10 +58,6 @@ pip install --user duniterpy ...@@ -58,10 +58,6 @@ pip install --user duniterpy
Once you want to add DuniterPy to your Python project, you can add it as a dependency to your Python development environment: `pyproject.toml`, `requirements.txt`, `setup.py`. Once you want to add DuniterPy to your Python project, you can add it as a dependency to your Python development environment: `pyproject.toml`, `requirements.txt`, `setup.py`.
We recommend [Poetry](https://python-poetry.org) usage. We recommend [Poetry](https://python-poetry.org) usage.
## Install the development environment
- [Install Poetry](https://python-poetry.org/docs/#installation)
## Documentation ## Documentation
[Online official automaticaly generated documentation](https://clients.pages.duniter.org/python/duniterpy/index.html) [Online official automaticaly generated documentation](https://clients.pages.duniter.org/python/duniterpy/index.html)
...@@ -74,15 +70,17 @@ The [examples folder](https://git.duniter.org/clients/python/duniterpy/tree/mast ...@@ -74,15 +70,17 @@ The [examples folder](https://git.duniter.org/clients/python/duniterpy/tree/mast
- Run examples from parent folder directly - Run examples from parent folder directly
```bash ```bash
poetry run python examples/request_data.py python examples/request_data.py
``` ```
Or from Python interpreter: Or from Python interpreter:
```bash ```bash
poetry run python python
>>> import examples >>> import examples
# To list available examples
>>> help(examples) >>> help(examples)
# Run example
>>> examples.create_public_key() >>> examples.create_public_key()
``` ```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment