Add shell auto-completion

[hoonman]

• I understand that this repository is auto-generated and my pull request may not be merged

Changes being requested

Contributors: @Tienbruh, @JesusG2022, @hoonman

Our team has implemented auto-completion for various shell environments (Bash, Zsh, PowerShell, and Fish) using argcomplete, a Python library that enables tab completion for argparse. We have integrated argcomplete into the _cli.py file, updated the pyproject.toml file to include argcomplete, and revised the README.md to provide instructions on activating the tab completion feature.

Additional context & links

This addresses #843

[RobertCraigie]

Thanks for putting this together!

[RobertCraigie]

I'd like to avoid adding a new required dependency, can we add this as an optional dependency?

I'm thinking something like this, thoughts?

pip install openai[cli]

[hoonman]

Thank you for the feedback! Our team discussed this and wanted to share our approach to add argcomplete as an optional dependency.

To avoid making argcomplete a required dependency, we plan to:

1. Change argcomplete from a required to an optional dependency in pyproject.toml.
2. Add a proxy file for argcomplete to handle optional imports.
3. Update the __init__.py file in the extras directory to reflect these changes.
4. Modify the README to instruct users to use the [cli] option to install argcomplete.

Please let us know if there are any additional changes we should consider.

[RobertCraigie]

That sounds good to me! I don't think there's any other changes needed.

For what it's worth I don't think we need the complexity of a proxy here though as the dependency is only ever used in one place anyway we can just change that call site to try ... except ImportError

[hoonman]

We have included the changes for making argcomplete an optional dependency, the try...except ImportError to the _cli.py, as well as the pip install openai[cli] command in the README. Let me know if there's anything else that needs modification. Thank you!

[RobertCraigie]

question: are there existing docs we could link to here instead of listing out all the possible environments here? maybe argcomplete's docs?

[Tienbruh]

Both temporary and permanent argcomplete activation instructions for Fish and Powershell are available on argcomplete's contrib directory. However, only the temporary activation commands for Bash and Zsh are listed on argcomplete's README file. The commands to activate autocompletion permanently for Bash and Zsh are not found anywhere on argcomplete's docs.

What are your opinions on replacing all the other environment activation instructions with the appropriate links to argcomplete's docs, while keeping these lines for permanent activation on Bash and Zsh?

For Bash:

register-python-argcomplete openai >> ~/.bashrc

For Zsh:

register-python-argcomplete openai >> ~/.zshrc