Skip to content

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PLePort wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Minor changes to README to ensure a streamlined setup expierience #5066

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f1e087
Update README.rst
PLePort Dec 6, 2025
37bd01f
Update README.rst
PLePort Dec 6, 2025
2d914a0
Update README.rst
PLePort Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,12 @@ You can install or upgrade ``python-telegram-bot`` via

.. code:: shell

#Requires Python 3.10+.
Copy link
Member

@Bibo-Joshi Bibo-Joshi Dec 6, 2025

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 python-telegram-bot --upgrade

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.
Copy link
Member

@Bibo-Joshi Bibo-Joshi Dec 6, 2025

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?


.. code:: shell

Expand Down Expand Up @@ -166,8 +167,8 @@ To install multiple optional dependencies, separate them by commas, e.g. ``pip i

Additionally, two shortcuts are provided:

* ``pip install "python-telegram-bot[all]"`` installs all optional dependencies.
* ``pip install "python-telegram-bot[ext]"`` installs all optional dependencies that are related to ``telegram.ext``, i.e. ``[rate-limiter, webhooks, callback-data, job-queue]``.
* ``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]``.
Comment on lines +170 to +171
Copy link
Member

@Bibo-Joshi Bibo-Joshi Dec 6, 2025

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.


Working with PTB
----------------
Expand Down