Skip to content

Commit d9209cc

Browse files
docs(readme): add link to demos directory and fix pyproject.toml per-file-ignore path
1 parent dc101bc commit d9209cc

10 files changed

Lines changed: 98 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ pc = WorkflowPC(flow.render())
6262
pc.run_sync()
6363
```
6464

65+
See more demos in `demos/`
66+
6567
## Documentation
6668

6769
Full guides, concept explanations, and API reference at **[sense.amritabot.com](https://sense.amritabot.com)**.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ ignore = [
5252
"RUF003", # ambiguous-unicode-character-comment
5353
]
5454
[tool.ruff.lint.per-file-ignores]
55-
"demo/*.py" = ["ASYNC250"]
55+
"demos/*.py" = ["ASYNC250"]
5656
"tests/*.py" = ["ASYNC250", "PERF401"]
5757

5858
[tool.pyright]

scripts/ci.sh

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#!/usr/bin/env bash
2+
# ci.sh — Full CI pipeline (init → lint → test → build).
3+
# Run this locally to simulate what CI does.
4+
set -euo pipefail
5+
6+
echo "========== 1. Init environment =========="
7+
uv venv
8+
uv sync
9+
10+
echo ""
11+
echo "========== 2. Type check (Pyright) =========="
12+
uv run pyright
13+
14+
echo ""
15+
echo "========== 3. Lint (Ruff) =========="
16+
uv run ruff check .
17+
18+
echo ""
19+
echo "========== 4. Unit tests with coverage =========="
20+
uv run pytest tests/ \
21+
--cov=src/amrita_sense \
22+
--cov-report=term-missing \
23+
--cov-report=xml \
24+
-v
25+
26+
echo ""
27+
echo "========== 5. Build package =========="
28+
uv build
29+
30+
echo ""
31+
echo "========== 6. Build docs =========="
32+
npm run docs:build
33+
34+
echo ""
35+
echo "=== CI pipeline complete ==="

scripts/docs-build.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env bash
2+
# docs-build.sh — Build the VitePress documentation.
3+
set -euo pipefail
4+
5+
echo "=== Building docs ==="
6+
npm run docs:build

scripts/docs-dev.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env bash
2+
# docs-dev.sh — Start the VitePress dev server with hot reload.
3+
set -euo pipefail
4+
5+
echo "=== Starting VitePress dev server ==="
6+
npm run docs:dev

scripts/docs-init.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env bash
2+
# docs-init.sh — Install docs dependencies.
3+
set -euo pipefail
4+
5+
echo "=== Installing docs dependencies ==="
6+
npm install

scripts/init-env.sh

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/usr/bin/env bash
2+
# init-env.sh — Initialize the Python virtual environment and install dependencies.
3+
set -euo pipefail
4+
5+
echo "=== Creating virtual environment ==="
6+
uv venv
7+
8+
echo "=== Installing dependencies ==="
9+
uv sync
10+
11+
echo "=== Done ==="
12+
echo "Activate with: source .venv/bin/activate"

scripts/lint.sh

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/usr/bin/env bash
2+
# lint.sh — Run linters and type checker.
3+
set -euo pipefail
4+
5+
echo "=== Pyright ==="
6+
uv run pyright
7+
8+
echo ""
9+
echo "=== Ruff check ==="
10+
uv run ruff check .
11+
12+
echo ""
13+
echo "=== Ruff format check ==="
14+
uv run ruff format --check .

scripts/test-cov.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/usr/bin/env bash
2+
# test-cov.sh — Run unit tests with coverage report.
3+
set -euo pipefail
4+
5+
echo "=== Running tests with coverage ==="
6+
uv run pytest tests/ \
7+
--cov=src/amrita_sense \
8+
--cov-report=term-missing \
9+
--cov-report=xml \
10+
-v

scripts/test.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env bash
2+
# test.sh — Run unit tests without coverage.
3+
set -euo pipefail
4+
5+
echo "=== Running unit tests ==="
6+
uv run pytest tests/ -v

0 commit comments

Comments
 (0)