Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify whether this repo is deprecated or not #41

Open
zbentley opened this issue Jun 4, 2021 · 5 comments
Open

Clarify whether this repo is deprecated or not #41

zbentley opened this issue Jun 4, 2021 · 5 comments

Comments

@zbentley
Copy link

zbentley commented Jun 4, 2021

This repo appears to duplicate (and maybe pre-date?) the official Click completion functionality.

Is this the predecessor to that/was that rolled into Click core at some point? If so, it might be good to:

  • Indicate that this is deprecated/rolled into core at the top of the README.
  • Contact the authors of open bugs and PRs on this repo and suggest that they move their issues to Click core if they're still applicable.
  • Maybe archive this repository?

If this is not a dupe of the click core functionality, and is instead an alternative implementation (or internal implementation component of the Click core func), it would be good to indicate that prominently in the README.

@zbentley zbentley changed the title Clarify whether this repo is deprecated or not` Clarify whether this repo is deprecated or not Jun 4, 2021
tilsche added a commit to metricq/metricq-python that referenced this issue Jun 1, 2023
Shell completion is now supported by click itself and the extra package is dead.

click-contrib/click-completion#37
click-contrib/click-completion#41

It is still not trivial to use because it needs to be enabled for the shell.
And maybe is and always was impossible for these example .py files because they are not real commands anyway.

https://click.palletsprojects.com/en/8.1.x/shell-completion/
tilsche added a commit to metricq/metricq-python that referenced this issue Jun 1, 2023
Shell completion is now supported by click itself and the extra package is dead.

click-contrib/click-completion#37
click-contrib/click-completion#41

It is still not trivial to use because it needs to be enabled for the shell.
And maybe is and always was impossible for these example .py files because they are not real commands anyway.

https://click.palletsprojects.com/en/8.1.x/shell-completion/
tilsche added a commit to metricq/metricq-source-sysinfo that referenced this issue Jun 1, 2023
Shell completion is now supported by click itself and the extra package is dead.

click-contrib/click-completion#37
click-contrib/click-completion#41

It is still not trivial to use because it needs to be enabled for the shell.
And maybe is and always was impossible for these example .py files because they are not real commands anyway.

https://click.palletsprojects.com/en/8.1.x/shell-completion/
tilsche added a commit to metricq/metricq-python that referenced this issue Jun 1, 2023
Shell completion is now supported by click itself and the extra package is dead.

click-contrib/click-completion#37
click-contrib/click-completion#41

It is still not trivial to use because it needs to be enabled for the shell.
And maybe is and always was impossible for these example .py files because they are not real commands anyway.

https://click.palletsprojects.com/en/8.1.x/shell-completion/
tilsche added a commit to metricq/metricq-tools that referenced this issue Jun 2, 2023
Shell completion is now supported by click itself and the extra package is dead.

click-contrib/click-completion#37
click-contrib/click-completion#41

It is still not trivial to use because it needs to be enabled for the shell.
And maybe is and always was impossible for these example .py files because they are not real commands anyway.

https://click.palletsprojects.com/en/8.1.x/shell-completion/
@tmax22
Copy link

tmax22 commented Jan 29, 2024

yup. probably dead

@n1ngu
Copy link

n1ngu commented Jan 30, 2024

I understand part of the answer is here #37

Click's completion system has been rewritten [...] Due to all these changes, the click-completion won't work with the next release of Click. We've talked about merging this project into Click before, but I think we pretty much have what we want in core at this point. One option is to make a release that specifies click<8 in install_requires, then have the next version specify click>=8 and continue to support the parts that Click doesn't provide.

So

  • yes, this is mostly an alternative implementation of click's core shell-completion features that didn't exist before
  • no, this was never rolled into core
  • both features are incompatible so this project should restrict to click<=7
  • this project could still aim to support the features that are considered out-of-scope in click>=8 (namely: powershell support, completion install command, shell detection)

But this is still to be done and the project feels very stale. I guess the release of click 8 removed most of the interest on maintaining click-completion for both the maintainers and the community.

So: ping @glehmann @Konubinix , sorry to bother you. A word about this? IMHO one of the following should happen

  • you just state that a PR (most probably a scratch-rewrite) to support click>=8 is welcome if anyone is willing to work on that and reboot the extra features in click-completion this was already addressed Added templates that are compatible with click 8 #45
  • the repsitory is archieved
  • new maintainers are involved in the project

Thanks!

@Konubinix
Copy link
Collaborator

To me, it is dead. In my projects, I try to use the native completion as much as possible and suggest you do the same.

I agree with your suggestions. I leave to @glehmann to make actions he deems appropriate.

@glehmann
Copy link
Collaborator

click's native completion should be used with click 8.0. This one is for click before 8.0.

If click's completion is not as complete as this one, we (as a community) should work on the missing features directly in click.

I'll add a notice at the top of the README and update the required click version to < 8.0

@a-detiste
Copy link
Contributor

please tag a maintenance release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants