You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+25-22Lines changed: 25 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,36 +10,39 @@ Banks is a Python prompt programming language and templating system for LLM appl
10
10
11
11
```bash
12
12
# Most common commands
13
-
hatch run test# Run unit tests
14
-
hatch run lint:all # Run all linting checks
15
-
hatch run lint:fmt# Auto-format code
16
-
hatch run test tests/test_foo.py # Run specific test file
13
+
uv run pytest tests# Run unit tests
14
+
uv run ruff format --check && uv run ruff check .&& uv run mypy --install-types --non-interactive src/banks && uv run pylint src/banks# Run all linting checks
15
+
uv run ruff format # Auto-format code
16
+
uv run pytest tests/test_foo.py# Run specific test file
17
17
```
18
18
19
19
## Development Commands
20
20
21
+
### Setup
22
+
- Install dev dependencies: `uv sync --extra dev`
23
+
21
24
### Testing
22
-
- Run tests: `hatch run test`
23
-
- Run tests with coverage: `hatch run test-cov`
24
-
- Generate coverage report: `hatch run cov`
25
-
- Run specific test file: `hatch run test tests/test_foo.py`
26
-
- Run e2e tests: `hatch run test tests/e2e/` (requires API keys)
25
+
- Run tests: `uv run pytest tests`
26
+
- Run tests with coverage: `uv run pytest --cov --cov-report=xml tests`
- Run specific test file: `uv run pytest tests/test_foo.py`
29
+
- Run e2e tests: `uv run pytest tests/e2e/` (requires API keys)
27
30
28
31
### Linting and Type Checking
29
-
- Format code: `hatch run lint:fmt`
30
-
- Auto-fix lint issues: `hatch run lint:fix`
31
-
- Check formatting: `hatch run lint:check`
32
-
- Run type checking: `hatch run lint:typing`
33
-
- Run pylint: `hatch run lint:lint`
34
-
- Run all lint checks: `hatch run lint:all`
32
+
- Format code: `uv run ruff format`
33
+
- Auto-fix lint issues: `uv run ruff check --fix`
34
+
- Check formatting: `uv run ruff format --check && uv run ruff check .`
35
+
- Run type checking: `uv run mypy --install-types --non-interactive src/banks`
36
+
- Run pylint: `uv run pylint src/banks`
37
+
- Run all lint checks: `uv run ruff format --check && uv run ruff check . && uv run mypy --install-types --non-interactive src/banks && uv run pylint src/banks`
35
38
36
39
### Documentation
37
-
- Build docs: `hatch run docs build`
38
-
- Serve docs locally: `hatch run docs serve` (available at http://127.0.0.1:8000/)
40
+
- Build docs: `uv run mkdocs build`
41
+
- Serve docs locally: `uv run mkdocs serve` (available at http://127.0.0.1:8000/)
39
42
40
43
### Environment Management
41
-
-All commands use Hatch environments with automatic dependency management
42
-
-Uses `uv` as the installer for faster dependency resolution
44
+
-Uses `uv` for dependency management and running tools
45
+
-Install all dev dependencies: `uv sync --extra dev`
43
46
- Python 3.9+ supported (tested on 3.10-3.14)
44
47
45
48
## Architecture Overview
@@ -157,9 +160,9 @@ hatch run test tests/test_foo.py # Run specific test file
157
160
158
161
### Running Specific Tests
159
162
```bash
160
-
hatch run test tests/test_image.py # Single file
161
-
hatch run test tests/test_image.py::test_name # Single test
162
-
hatch run test -k "image"# Tests matching pattern
163
+
uv run pytest tests/test_image.py # Single file
164
+
uv run pytest tests/test_image.py::test_name # Single test
0 commit comments