Question: rename prompt_toolkit to prompt_toolkit2 or not? (during a transition period).
See original GitHub issueHi everyone,
I’m opening this issue to discuss whether or not we should rename prompt_toolkit
to prompt_toolkit2
.
The problem that we are facing right now is that we want to release version 2.0, but it’s backwards incompatible with 1.0. This would normally not be an issue, because the best practices tell you to install Python applications in a virtualenv. However, most prompt_toolkit applications are system tools, which are often installed with the system wide Python installation, and very often these are distributed through other channels like the repositories of Linux distributions. We don’t want to break those.
As I understand it, setuptools can install multiple versions of a package alongside each other. There is a __requires__
variable that is inspected by pkg_resources to make sure the right version of the package is loaded. (See, e.g.: https://stackoverflow.com/questions/13720065/what-does-requires-mean-in-python ). However, I’m not sure how well this works in practice.
While I don’t like it, if renaming this library to prompt_toolkit2
during a transition period is the only way to solve certain issues, then I’m in favor of doing it. The intend is to rename it back to prompt_toolkit
when most applications are transitioned. (At that point, prompt_toolkit2
could remain an alias for prompt_toolkit
.)
I don’t have much personal experience with issues like this, so all feedback is welcome.
Issue Analytics
- State:
- Created 6 years ago
- Reactions:15
- Comments:30 (18 by maintainers)
Top GitHub Comments
@return42: it is possible that certain bug fixes will still be applied to the 1.0 branch, but I’d like to move as much as possible to the 2.0 branch. Maintaining two branches takes a lot of time.
Hi everyone,
I just released prompt_toolkit 2.0.1. Check the changelog: https://github.com/jonathanslenders/python-prompt-toolkit/blob/master/CHANGELOG and the docs: https://python-prompt-toolkit.readthedocs.io/ .
Please let me know if you have any issues upgrading your applications!
Cheers, Jonathan