Skip to content

docs: add Slack CLI setup instructions to README.md#80

Open
srtaalej wants to merge 6 commits into
mainfrom
add-slack-cli-instructions
Open

docs: add Slack CLI setup instructions to README.md#80
srtaalej wants to merge 6 commits into
mainfrom
add-slack-cli-instructions

Conversation

@srtaalej
Copy link
Copy Markdown

@srtaalej srtaalej commented May 12, 2026

Summary

  • Adds collapsible "Using Slack CLI" and "Using Terminal" sections to the installation guide
  • Matches the pattern used by bolt-python-assistant-template and bolt-python-search-template

Test plan

  • Verify rendered README displays both collapsible sections correctly and commands are accurate

@srtaalej srtaalej requested a review from a team as a code owner May 12, 2026 19:05
@srtaalej srtaalej self-assigned this May 12, 2026
@srtaalej srtaalej added documentation Improvements or additions to documentation enhancement New feature or request labels May 12, 2026
Copy link
Copy Markdown
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Nice 💯

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

🪝 We might want to include the hooks package as part of pyproject.toml alongside this too?

@srtaalej srtaalej changed the title docs: add Slack CLI setup instructions to README docs: add Slack CLI setup instructions and project dependencies May 12, 2026
@srtaalej srtaalej requested a review from zimeg May 12, 2026 20:20
@slack-samples
Copy link
Copy Markdown
Contributor

slack-samples Bot commented May 12, 2026

$ slack create -t slack-samples/bolt-python-starter-template -b add-slack-cli-instructions

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

🎁 A few more comments on streamlining setups and stable packages!

Comment thread pyproject.toml Outdated
Comment on lines +6 to +8
"slack-sdk==3.41.0",
"slack-bolt>=1.28.0",
"slack-cli-hooks<1.0.0",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔬 suggestion: We should pick one of these options of versioning? I'd suggest exact pins because @dependabot should be checking back often!

Comment thread README.md Outdated
Comment on lines +35 to +44
#### 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:

```sh
slack install
```

After the Slack app has been created you're all set to start developing!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
#### 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:
```sh
slack install
```
After the Slack app has been created you're all set to start developing!

🪓 question: Might we remove this in favor of the run command installs?

@srtaalej srtaalej requested a review from zimeg May 12, 2026 20:37
Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

🪬 Leaving a note that we might want to separate CLI support from improved packaging!

Comment thread pyproject.toml Outdated
@@ -1,3 +1,13 @@
[project]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(.venv) $ pip install .
Processing /Users/eden.zimbelman/programming/samples/bolt-python-starter-template
  Installing build dependencies ... done
  Getting requirements to build wheel ... error
  error: subprocess-exited-with-error

  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [14 lines of output]
      error: Multiple top-level packages discovered in a flat-layout: ['logs', 'listeners'].

      To avoid accidental inclusion of unwanted files or directories,
      setuptools will not proceed with this build.

      If you are trying to create a single distribution with multiple packages
      on purpose, you should not rely on automatic discovery.
      Instead, consider the following options:

      1. set up custom discovery (`find` directive with `include` or `exclude`)
      2. use a `src-layout`
      3. explicitly set `py_modules` or `packages` with a list of names

      To find more information, look for "package discovery" on setuptools docs.
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.

[notice] A new release of pip is available: 24.3.1 -> 26.1.1
[notice] To update, run: pip install --upgrade pip
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

⚠️ issue: This might find conflict in new virtual environments? I'm wondering if we want to keep these changes focused to requirements.txt in this PR and follow up to favor pyproject.toml afterward

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

ah thanks for catching that! will do 🫡

@srtaalej srtaalej requested a review from zimeg May 14, 2026 14:15
@srtaalej srtaalej changed the title docs: add Slack CLI setup instructions and project dependencies docs: add Slack CLI setup instructions to README.md May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants