Skip to content

Commit 2dcd83b

Browse files
authored
Merge pull request #602 from onekey-sec/update-docs
docs: update development guide with proper installation steps.
2 parents b27debc + 63ff966 commit 2dcd83b

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/development.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,32 @@ pyenv local 3.8.12
9090

9191
### Installing Python dependencies
9292

93-
We are using [poetry](https://python-poetry.org/) to manage our Python dependencies. `poetry
94-
install` will install all required dependencies for development.
93+
We are using [poetry](https://python-poetry.org/) to manage our Python
94+
dependencies. To install all required dependencies for development, you can run
95+
the following command:
96+
97+
```
98+
poetry install --with dev
99+
```
100+
101+
Please note that it installs dependencies within the dedicated virtual
102+
environment. So if you want to run `unblob` or `pytest`, you need to do it from
103+
within the virtual environment:
104+
105+
Using poetry run:
106+
107+
```
108+
poetry run unblob
109+
poetry run pytest tests -v
110+
```
111+
112+
By dropping into the virtual environment:
113+
114+
```
115+
poetry shell
116+
unblob
117+
pytest tests -v
118+
```
95119

96120
### Running pre-commit
97121

0 commit comments

Comments
 (0)