Skip to content

Commit 8da4ff7

Browse files
Added uvx support
1 parent 9bc2b29 commit 8da4ff7

3 files changed

Lines changed: 35 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,21 @@ This kit contains utilities to download the VBR dataset
1919
pip install vbr-devkit
2020
```
2121

22+
## Run without installing (uvx)
23+
24+
If you have [uv](https://docs.astral.sh/uv/) installed, you can run the kit without installing it into your environment:
25+
26+
```shell
27+
uvx vbr-devkit list
28+
```
29+
30+
`uvx` fetches the package into a temporary, isolated environment and runs it. Any `vbr` command works through the `vbr-devkit` entry point, for example:
31+
32+
```shell
33+
uvx vbr-devkit download campus_train0 ~/data/
34+
uvx vbr-devkit convert kitti <input.bag> <output_dir>
35+
```
36+
2237
You can install autocompletion for our package by typing:
2338

2439
```shell

python/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,21 @@ This kit contains utilities to work on the VBR SLAM dataset
1515
pip install vbr-devkit
1616
```
1717

18+
## Run without installing (uvx)
19+
20+
If you have [uv](https://docs.astral.sh/uv/) installed, you can run the kit without installing it into your environment:
21+
22+
```shell
23+
uvx vbr-devkit list
24+
```
25+
26+
`uvx` fetches the package into a temporary, isolated environment and runs it. Any `vbr` command works through the `vbr-devkit` entry point, for example:
27+
28+
```shell
29+
uvx vbr-devkit download campus_train0 ~/data/
30+
uvx vbr-devkit convert kitti <input.bag> <output_dir>
31+
```
32+
1833
You can install autocompletion for our package by typing:
1934

2035
```shell

python/pyproject.toml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "vbr-devkit"
7-
version = "0.1.1"
7+
version = "0.1.2"
88
description = "Development kit for VBR SLAM dataset"
99
readme = "README.md"
1010
authors = [
@@ -13,7 +13,7 @@ authors = [
1313
]
1414
requires-python = ">=3.8"
1515

16-
classfiers = [
16+
classifiers = [
1717
"Programming Language :: Python :: 3",
1818
"License :: OSI Approved :: BSD License",
1919
"Operating System :: Unix",
@@ -25,13 +25,14 @@ dependencies = [
2525
"natsort",
2626
"numpy",
2727
"rich",
28-
"typer[all]>=0.10.0",
28+
"typer>=0.10.0",
2929
"rosbags==0.11.0",
30-
"rosbags.image"
30+
"rosbags-image[opencv-headless]"
3131
]
3232

3333
[project.scripts]
3434
vbr = "vbr_devkit.tools.run:app"
35+
vbr-devkit = "vbr_devkit.tools.run:app"
3536

3637
[project.urls]
3738
Homepage = "https://github.com/rvp-group/vbr-devkit"

0 commit comments

Comments
 (0)