docs: add Slack CLI setup instructions to README.md#80
Conversation
zimeg
left a comment
There was a problem hiding this comment.
🪝 We might want to include the hooks package as part of pyproject.toml alongside this too?
|
zimeg
left a comment
There was a problem hiding this comment.
🎁 A few more comments on streamlining setups and stable packages!
| "slack-sdk==3.41.0", | ||
| "slack-bolt>=1.28.0", | ||
| "slack-cli-hooks<1.0.0", |
There was a problem hiding this comment.
🔬 suggestion: We should pick one of these options of versioning? I'd suggest exact pins because @dependabot should be checking back often!
| #### 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! | ||
|
|
There was a problem hiding this comment.
| #### 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?
zimeg
left a comment
There was a problem hiding this comment.
🪬 Leaving a note that we might want to separate CLI support from improved packaging!
| @@ -1,3 +1,13 @@ | |||
| [project] | |||
There was a problem hiding this comment.
(.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.
requirements.txt in this PR and follow up to favor pyproject.toml afterward
There was a problem hiding this comment.
ah thanks for catching that! will do 🫡
zimeg
left a comment
There was a problem hiding this comment.
🙏 @srtaalej LGTM! I'm leaving one more suggestion of a command we might remove before a first "run" happens although I think keeping this step can make setup more clear...
Your call on if we keep it or not or let this be a later decision!
| You'll also need to log in if this is your first time using the Slack CLI. | ||
|
|
||
| ```sh | ||
| slack login | ||
| ``` | ||
|
|
There was a problem hiding this comment.
| You'll also need to log in if this is your first time using the Slack CLI. | |
| ```sh | |
| slack login | |
| ``` |
🪓 suggestion: We can perhaps remove this too! I found it confusing when searching for the first step to use this template
There was a problem hiding this comment.
hmm i think we should keep for now.login is important for new user setup 💭
Summary
bolt-python-assistant-templateandbolt-python-search-templateTest plan