search

slackapi / bolt-python

A framework to build Slack apps using Python
https://tools.slack.dev/bolt-python/
MIT License
1.07k stars 245 forks source link

Centralize python setup guide #777

Open WilliamBergamin opened 1 year ago

WilliamBergamin commented 1 year ago

Through out the docs and guides we mention how to set up a python project using pyenv, python, venv and pip, it would be nice to centralize this and reference a common resource.

The page URLs

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

seratch commented 1 year ago

I think having a link to a Python setup page instead is not a really great developer experience. If you can have a reusable part for many pages and embed it easily, it would be great.

hello-ashleyintech commented 5 months ago

@srtaalej Find virtual env creation throughout the docs (README, maintainer's guide, slack.dev) and find a way to have one standardized approach or source of truth (example areas this appears: https://github.com/slackapi/bolt-python?tab=readme-ov-file#setup and https://github.com/slackapi/bolt-python/blob/main/.github/maintainers_guide.md#python-and-friends and https://slack.dev/bolt-python/tutorial/getting-started#setting-up-your-project and https://slack.dev/bolt-python/tutorial/getting-started-http)

If possible, have some sort of variable or component that dynamically injects the same info - basically try to standardize it across the board. Could find a way to source this globally and inject it - we just want to find a way to reduce redundancy in favor of one standardized approach

Can be an exploratory PR - if one specific source isn't possible, then we can find an alternate approach. @seratch and @WilliamBergamin are good points of contact for this!