Update config & readme

ElectronicBabylonianLiterature · Jan 26, 2025 · cef0075 · cef0075
1 parent ec6cf65
commit cef0075
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -64,7 +64,7 @@ jobs:
         run: |
           pip install --upgrade pip
           pip install poetry
-          poetry install --no-root
+          poetry install --no-root --with dev
 
       - name: Lint
         if: success() || steps.install.outcome == 'success'

diff --git a/.gitpod.yml b/.gitpod.yml
@@ -9,7 +9,7 @@ ports:
 
 # List the start up tasks. You can start them in parallel in multiple terminals. See https://www.gitpod.io/docs/44_config_start_tasks/
 tasks:
-- init: poetry install --no-root
+- init: poetry install --no-root --with dev
 - init: mkdir -p /workspace/data
   command: mongod --dbpath /workspace/data --bind_ip 127.0.0.1
 

diff --git a/README.md b/README.md
@@ -22,9 +22,11 @@ Requirements:
 
 ```shell script
 pip install poetry
-poetry install
+poetry install --no-root
 ```
 
+For development, use `poetry install --no-root --with dev`.
+
 If `libcst` installation fails (because a binary wheel is not available for Linux/Windows + Pypy) you may need to install
 the [rust compiler](https://www.rust-lang.org/tools/install) to solve it.
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -36,7 +36,9 @@ natsort = "^8.4.0"
 ruff = "^0.5.5"
 
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev]
+optional = true
+[tool.poetry.group.dev.dependencies]
 pytest = "*"
 pytest-cov = "*"
 freezegun = "*"