Skip to content

docs: instruct virtual environment setup with the slack cli before configuring providers #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zimeg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: instruct virtual environment setup with the slack cli before configuring providers #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,19 @@ slack create my-bolt-python-assistant --template slack-samples/bolt-python-assis
cd my-bolt-python-assistant
```

#### Setup your python virtual environment

```sh
python3 -m venv .venv
source .venv/bin/activate # for Windows OS, .\.venv\Scripts\Activate instead should work
```
Comment on lines +41 to +44
Copy link
Member

@mwbrooks mwbrooks Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: For readability, we could put the Windows suggestion on a different line.

Suggested change
```sh
python3 -m venv .venv
source .venv/bin/activate # for Windows OS, .\.venv\Scripts\Activate instead should work
```
```sh
python3 -m venv .venv
source .venv/bin/activate
# Windows OS can run:
# .\.venv\Scripts\Activate


#### Install dependencies

```sh
pip install -r requirements.txt
```

Comment on lines +39 to +51
Copy link
Member Author

@zimeg zimeg Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📚 note: This matches the Quickstart guide and mirrors a section below for "Terminal" setup at this time.

#### Creating the Slack app

Use the following command to add your new Slack app to your development workspace. Choose a "local" app environment for upcoming development:
Copy link
Member Author

@zimeg zimeg Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 thought: I'm not so confident in the wording here and am open to suggestions! FWIW "local" might be a CLI-specific term at the moment but slackapi/slack-cli#307 might be relevant for upcoming changes!

Copy link
Member

@mwbrooks mwbrooks Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can definitely improve the wording, but at least "local" is aligned with the current CLI output.

Expand All @@ -44,7 +57,7 @@ Use the following command to add your new Slack app to your development workspac
slack install
```

After the Slack app has been created you're all set to configure the LLM provider!
After the Slack app has been created you're all set to [configure the LLM provider](#providers)!
Copy link
Contributor

@srtaalej srtaalej Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⭐


### Using Terminal

Expand Down