From 0381159f3180efc032412b11fa26c8c27e0835ea Mon Sep 17 00:00:00 2001 From: Kotaro Uetake <60615504+ktro2828@users.noreply.github.com> Date: Wed, 15 Jan 2025 07:28:25 +0900 Subject: [PATCH] chore: add dev-dependencies (#87) Signed-off-by: ktro2828 --- .github/workflows/build-and-test.yaml | 2 +- .github/workflows/deploy-document.yaml | 2 +- README.md | 11 +++++++++-- docs/install.md | 11 +++++++++-- pyproject.toml | 2 +- 5 files changed, 21 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml index fde5e49..4cf480e 100644 --- a/.github/workflows/build-and-test.yaml +++ b/.github/workflows/build-and-test.yaml @@ -32,7 +32,7 @@ jobs: enable-cache: true - name: Install the project - run: uv sync --all-extras + run: uv sync - name: Run tests run: uv run pytest --cov-report xml:coverage.xml --cov=t4_devkit diff --git a/.github/workflows/deploy-document.yaml b/.github/workflows/deploy-document.yaml index 29e5ff1..e3412a6 100644 --- a/.github/workflows/deploy-document.yaml +++ b/.github/workflows/deploy-document.yaml @@ -17,7 +17,7 @@ jobs: python-version: "3.10" - name: Install the project - run: uv sync --all-extras + run: uv sync --only-dev - name: Create the document run: uv run mkdocs gh-deploy --force diff --git a/README.md b/README.md index f13d098..2b5ed1e 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,18 @@ pip install git+https://github.com/tier4/t4-devkit.git@main #### Install from source +You need to install `uv`. For details, please refer to [OFFICIAL DOCUMENT](https://docs.astral.sh/uv/). + ```shell git clone git@github.com:tier4/t4-devkit.git cd t4-devkit -uv venv --python 3.10 -uv sync --all-extras +uv sync +``` + +The virtual environment can be activated with: + +```shell +source .venv/bin/activate ``` ## Dataset Format diff --git a/docs/install.md b/docs/install.md index 684bfc0..51e2f6e 100644 --- a/docs/install.md +++ b/docs/install.md @@ -16,9 +16,16 @@ pip install git+https://github.com/tier4/t4-devkit.git@main ## Install from source +You need to install `uv`. For details, please refer to [OFFICIAL DOCUMENT](https://docs.astral.sh/uv/). + ```shell git clone git@github.com:tier4/t4-devkit.git cd t4-devkit -uv venv --python 3.10 -uv sync --all-extras +uv sync +``` + +The virtual environment can be activated with: + +```shell +source .venv/bin/activate ``` diff --git a/pyproject.toml b/pyproject.toml index f1f5b31..9937506 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,7 @@ dependencies = [ "pycocotools>=2.0.8", ] -[project.optional-dependencies] +[dependency-groups] dev = [ "pytest>=8.2.2", "pytest-asyncio>=0.23.7",