Skip to content
Snippets Groups Projects
Commit 00e37a6f authored by Vincent Texier's avatar Vincent Texier Committed by Moul
Browse files

[doc] #66: fix typos in the README.md

parent aa990455
No related branches found
No related tags found
2 merge requests!101Release 0.57.0,!93#66: Introduce Poetry
...@@ -30,7 +30,7 @@ You can install DuniterPy and its dependencies with the following command: ...@@ -30,7 +30,7 @@ You can install DuniterPy and its dependencies with the following command:
pip3 install duniterpy --user pip3 install duniterpy --user
``` ```
## Install the development environement ## Install the development environment
- Install [Poetry](https://poetry.eustace.io): - Install [Poetry](https://poetry.eustace.io):
```bash ```bash
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python --preview curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python --preview
...@@ -59,7 +59,7 @@ make docs ...@@ -59,7 +59,7 @@ make docs
## Development ## Development
* When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features * When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
* Use make commands to check the code and the format it correct. * Use make commands to check the code and the format.
Black, the formatting tool, requires Python 3.6 or higher. Black, the formatting tool, requires Python 3.6 or higher.
...@@ -74,11 +74,11 @@ poetry install --no-dev ...@@ -74,11 +74,11 @@ poetry install --no-dev
poetry run python examples/request_data.py poetry run python examples/request_data.py
``` ```
* Before submiting 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
```bash ```bash
poetry instal poetry install
``` ```
* Check static typing with [mypy](http://mypy-lang.org/) * Check static typing with [mypy](http://mypy-lang.org/)
...@@ -105,7 +105,7 @@ Change and commit and tag the new version number (semantic version number) ...@@ -105,7 +105,7 @@ Change and commit and tag the new version number (semantic version number)
Build the PyPi package in the `dist` folder Build the PyPi package in the `dist` folder
```bash ```bash
Noetry build poetry build
``` ```
Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password) Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment