|
41 | 41 | - [Settings Cache Management](#settings-cache-management) |
42 | 42 | - [Flexible Configuration Options](#flexible-configuration-options) |
43 | 43 | - [Development](#development) |
44 | | - - [Create DEV Environment, Running Tests and Building Wheel](#create-dev-environment-running-tests-and-building-wheel) |
| 44 | + - [Create DEV Environment and Running Tests](#create-dev-environment-and-running-tests) |
| 45 | + - [Update DEV Environment Packages](#update-dev-environment-packages) |
| 46 | + - [Building Wheel](#building-wheel) |
45 | 47 | - [Optionals](#optionals) |
46 | 48 | - [License](#license) |
47 | 49 | - [Support](#support) |
@@ -349,20 +351,34 @@ RotateWhen.MONDAY # "W0" |
349 | 351 |
|
350 | 352 | # Development |
351 | 353 |
|
352 | | -Must have [UV](https://uv.run/docs/getting-started/installation), |
353 | | -[Black](https://black.readthedocs.io/en/stable/getting_started.html), |
354 | | -[Ruff](https://docs.astral.sh/ruff/installation/), and |
355 | | -[Poe the Poet](https://poethepoet.naber.dev/installation) installed. |
| 354 | +Must have [UV](https://uv.run/docs/getting-started/installation) installed. |
356 | 355 |
|
357 | | -## Create DEV Environment, Running Tests and Building Wheel |
| 356 | +## Create DEV Environment and Running Tests |
| 357 | + |
| 358 | +> **Note:** All poe tasks automatically run ruff linter along with Black formatting |
358 | 359 |
|
359 | 360 | ```shell |
360 | | -uv sync --all-extras |
361 | | -poe linter |
| 361 | +uv sync --all-extras --all-groups |
362 | 362 | poe test |
| 363 | +``` |
| 364 | + |
| 365 | + |
| 366 | +## Update DEV Environment Packages |
| 367 | +This will update all packages dependencies |
| 368 | + |
| 369 | +```shell |
| 370 | +poe updatedev |
| 371 | +``` |
| 372 | + |
| 373 | + |
| 374 | +## Building Wheel |
| 375 | +This will update all packages, run linter, both unit and integration tests and finally build the wheel |
| 376 | + |
| 377 | +```shell |
363 | 378 | poe build |
364 | 379 | ``` |
365 | 380 |
|
| 381 | + |
366 | 382 | ## Optionals |
367 | 383 |
|
368 | 384 | ### Create a cprofile.prof file from unit tests |
|
0 commit comments