Skip to content

Commit

Permalink
Merge pull request #602 from onekey-sec/update-docs
Browse files Browse the repository at this point in the history
docs: update development guide with proper installation steps.
  • Loading branch information
vlaci authored Jun 7, 2023
2 parents b27debc + 63ff966 commit 2dcd83b
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,32 @@ pyenv local 3.8.12

### Installing Python dependencies

We are using [poetry](https://python-poetry.org/) to manage our Python dependencies. `poetry
install` will install all required dependencies for development.
We are using [poetry](https://python-poetry.org/) to manage our Python
dependencies. To install all required dependencies for development, you can run
the following command:

```
poetry install --with dev
```

Please note that it installs dependencies within the dedicated virtual
environment. So if you want to run `unblob` or `pytest`, you need to do it from
within the virtual environment:

Using poetry run:

```
poetry run unblob
poetry run pytest tests -v
```

By dropping into the virtual environment:

```
poetry shell
unblob
pytest tests -v
```

### Running pre-commit

Expand Down

0 comments on commit 2dcd83b

Please sign in to comment.