Skip to content

Commit 92a660f

Browse files
committed
chore(tools/chatbot): update readme for lint and format commands
1 parent c722aec commit 92a660f

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

tools/chatbot/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
1414
### Installation
1515

1616
1. Install uv if you haven't already:
17+
1718
```bash
1819
curl -LsSf https://astral.sh/uv/install.sh | sh
1920
```
2021

2122
2. Install dependencies:
23+
2224
```bash
2325
uv sync
2426
```
@@ -33,7 +35,7 @@ uv run python chatbot.py
3335

3436
Create a `.env` file with the following variables:
3537

36-
```
38+
```txt
3739
SLACK_APP_TOKEN=xapp-...
3840
SLACK_BOT_TOKEN=xoxb-...
3941
OPENAI_API_KEY=sk-...
@@ -58,13 +60,13 @@ uv run pytest
5860
Format code:
5961

6062
```bash
61-
uv run black .
63+
uv run ruff format .
6264
```
6365

6466
Lint code:
6567

6668
```bash
67-
uv run flake8 .
69+
uv run ruff check .
6870
```
6971

7072
### Docker
@@ -74,4 +76,4 @@ Build and run with Docker:
7476
```bash
7577
docker build -t samu-hub-chatbot .
7678
docker run -d --env-file .env samu-hub-chatbot
77-
```
79+
```

0 commit comments

Comments
 (0)