Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,12 @@ pip install -e ".[dev]"

This project is a pure Python CLI. There is no separate compile or build step for normal development; installing in editable mode is enough to run the local `cbrain` command.

The `dev` extra installs the local review tools used by this repository:

- `ruff` for linting and formatting;
- `pytest` for focused unit tests;
- `pre-commit` for local hook checks.

### Linting And Formatting

Ruff is used for linting and formatting:
Expand Down Expand Up @@ -205,6 +211,12 @@ The existing test suite is based on capture tests in `capture_tests/`. These are

Capture tests require a local CBRAIN test server on `localhost:3000` with the expected test database seed. The GitHub Actions workflow sets this up by checking out the CBRAIN server repository at https://github.com/aces/cbrain.

Focused unit tests should use `pytest` and should not require a live CBRAIN server:

```bash
pytest
```

When command output intentionally changes, update `capture_tests/expected_captures.txt`. When behavior changes without intended output changes, prefer adding focused unit tests where possible.

### Continuous Integration
Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ console_scripts =
[options.extras_require]
dev =
pre-commit>=3.5.0
pytest>=8.0.0
ruff>=0.8.5
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
extras_require={
"dev": [
"pre-commit>=3.5.0",
"pytest>=8.0.0",
"ruff>=0.8.5",
],
},
Expand Down
Loading