Skip to content

Commit 6b87275

Browse files
committed
docs: poetry -> uv
1 parent 9a98792 commit 6b87275

File tree

4 files changed

+16
-22
lines changed

4 files changed

+16
-22
lines changed

docs/development.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ where the exciting stuff is.
3232
- **git**: You need it for cloning the repository.
3333
Install it [from the git-scm website](https://git-scm.com/download).
3434

35-
- **Poetry**: it is a package manager for Python dependencies. Follow the instructions on the
36-
[Poetry website](https://python-poetry.org/docs/master/#installation) to install the latest version.
35+
- **uv**: it is a package manager for Python dependencies. Follow the instructions on the
36+
[uv website](https://docs.astral.sh/uv/getting-started/installation/) to install the latest version.
3737

3838
- **pre-commit**: We are using [pre-commit](https://pre-commit.com/) to run
3939
checks like linters, type checks and formatting issues.
@@ -72,16 +72,10 @@ You need to setup Git LFS once, before you will be able to run the whole test su
7272

7373
The recommended way to develop Python projects in a semi-isolated way is to use `virtualenv`.
7474

75-
If you don't want to manage it separately, you can rely on `Poetry` to automatically
75+
If you don't want to manage it separately, you can rely on `uv` to automatically
7676
create a virtualenv for you on install.
7777

78-
If you don't want Poetry to automatically create a virtualenv, you can turn it off with this command:
79-
80-
```shell
81-
poetry config virtualenvs.create false
82-
```
83-
84-
Or instead of Poetry you can use `pyenv`. You can set the Python interpreter
78+
Or instead of uv you can use `pyenv`. You can set the Python interpreter
8579
version for the local folder only with:
8680

8781
```
@@ -90,29 +84,29 @@ pyenv local 3.12.7
9084

9185
### Installing Python dependencies
9286

93-
We are using [poetry](https://python-poetry.org/) to manage our Python
87+
We are using [uv](https://docs.astral.sh/uv/) to manage our Python
9488
dependencies. To install all required dependencies for development, you can run
9589
the following command:
9690

9791
```
98-
poetry install --with dev
92+
uv install
9993
```
10094

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

105-
Using poetry run:
99+
Using uv run:
106100

107101
```
108-
poetry run unblob
109-
poetry run pytest tests -v
102+
uv run unblob
103+
uv run pytest tests -v
110104
```
111105

112106
By dropping into the virtual environment:
113107

114108
```
115-
poetry shell
109+
uv run $SHELL
116110
unblob
117111
pytest tests -v
118112
```

docs/extractors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The following executables found installed, which are needed by unblob:
4949

5050
✅: These extractors come with unblob, check
5151
[pyproject.toml](https://github.com/onekey-sec/unblob/blob/main/pyproject.toml)
52-
and [poetry.lock](https://github.com/onekey-sec/unblob/blob/main/poetry.lock)
52+
and [uv.lock](https://github.com/onekey-sec/unblob/blob/main/uv.lock)
5353
for current versions.
5454

5555
| Extractor | Provided commands | Minimum version | Pre-Installed | More information |

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ unblob has been developed with the following objectives in mind:
6060
tested](https://github.com/onekey-sec/unblob/issues?q=label%3Afuzzing+)
6161
against a large corpus of files and firmware images. We rely on up-to-date
6262
third party dependencies that are
63-
[locked](https://github.com/onekey-sec/unblob/blob/main/poetry.lock) to limit
63+
[locked](https://github.com/onekey-sec/unblob/blob/main/uv.lock) to limit
6464
potential supply chain issues. We use safe extractors that we audited and
6565
fixed where required (see [path traversal in
6666
ubi_reader](https://github.com/onekey-sec/ubi_reader/commit/4a81f3f0a714bb83d6ee71db09b7748619fa9fb7),

docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,23 +192,23 @@ For imperative package installation, follow these steps:
192192
## From source
193193

194194
1. Install [Git](https://git-scm.com/download/) if you don't have it yet.
195-
2. Install the [Poetry](https://python-poetry.org/docs/#installation) Python package manager.
195+
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/) Python package manager.
196196
3. **Clone** the unblob **repository from GitHub**:
197197

198198
git clone https://github.com/onekey-sec/unblob.git
199199

200-
4. Install **Python dependencies** with Poetry:
200+
4. Install **Python dependencies** with uv:
201201

202202
1. Python packages:
203203

204204
cd unblob
205-
poetry install --no-dev
205+
uv sync --no-dev
206206

207207
2. Make sure you [installed all extractors](#install-extractors).
208208

209209
3. Check that everything works correctly:
210210

211-
poetry run unblob --show-external-dependencies
211+
uv run unblob --show-external-dependencies
212212

213213
## Install extractors
214214

0 commit comments

Comments
 (0)