- Notifications
You must be signed in to change notification settings - Fork5.9k
Minor changes to README to ensure a streamlined setup expierience#5066
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Conversation
Bibo-Joshi left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Hey. Thanks for taking the time to PR! I've left some comments below
| ..code::shell | ||
| #Requires Python 3.10+. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Instead of having this as comment in the shell, I suggest moving it up to line 100, i.e.… ptb on Python 3.10+ via …
| * ``pip install-U"python-telegram-bot[all]"`` installs all optional dependencies. | ||
| * ``pip install-U"python-telegram-bot[ext]"`` installs all optional dependencies that are related to ``telegram.ext``, i.e. ``[rate-limiter, webhooks, callback-data, job-queue]``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
TBH I'd prefer not to have the upgrade option here. It's likely that people get to this section if they already have PTB installed but need an additional optional dependency. In that case, upgrading PTB might not actually be desired.
| To install a pre-release, use the ``--pre`` `flag<https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-pre>`_ in addition. | ||
| You can also install ``python-telegram-bot`` from source, though this is usually not necessary. | ||
| You can also install ``python-telegram-bot`` from source, though this is usually not necessary. Before building from source, check that Pything headers and a C compiler are installed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
PTB is a pure-python package and doesn't have any C-bindings. What do you thnik Python headers & C compilers are required for?
Installing: Added another comment before $ pip install python-telegram-bot --upgrade that reinforces the need for Python 3.10+. I know this was stated at the beginning of the README, but adding it here would just act as another safety right before install in case it was glossed over. Also, I added a short note that building PTB from source requires Python headers and a C compiler.
Optional Dependencies: Added -U to the pip installs just in case there are outdated dependencies.