Minor changes to README to ensure a streamlined setup expierience #5066
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bibo-Joshi
requested changes
Dec 6, 2025
Member
Bibo-Joshi
left a comment
Bibo-Joshi
left a comment
There was a problem hiding this comment.
Hey. Thanks for taking the time to PR! I've left some comments below
|
|
||
| .. code:: shell | ||
| #Requires Python 3.10+. |
Member
There was a problem hiding this comment.
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 …
Comment on lines
+170
to
+171
| * ``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]``. |
Member
There was a problem hiding this comment.
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. |
Member
There was a problem hiding this comment.
PTB is a pure-python package and doesn't have any C-bindings. What do you thnik Python headers & C compilers are required for?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.