Metadata-Version: 2.1
Name: xontrib-argcomplete
Version: 0.2.3
Summary: Adding support of kislyuk/argcomplete to xonsh.
Home-page: https://github.com/anki-code/xontrib-argcomplete
Author: anki-code
Author-email: author@example.com
License: BSD
Project-URL: Documentation, https://github.com/anki-code/xontrib-argcomplete/blob/master/README.md
Project-URL: Code, https://github.com/anki-code/xontrib-argcomplete
Project-URL: Issue tracker, https://github.com/anki-code/xontrib-argcomplete/issues
Description: <p align="center">
        Adding support of <a href="https://github.com/kislyuk/argcomplete">argcomplete</a> to <a href="https://xon.sh">xonsh</a>. Xonsh scripts supported.
        </p>
        
        <p align="center">  
        If you like the idea click ⭐ on the repo and stay tuned by watching releases.
        </p>
        
        ## Install
        ```shell script
        xpip install xontrib-argcomplete
        echo 'xontrib load argcomplete' >> ~/.xonshrc
        # Reload xonsh
        ```
        
        ## Usage
        
        Before usage you must [add the argcomplete support to your script](https://kislyuk.github.io/argcomplete/#synopsis). The `PYTHON_ARGCOMPLETE_OK` marker should be found in the first 10 lines of the file.
        
        The argcomplete xonsh completer will be activated with this cases:
        ```bash
        python script.py
        ./script.py
        ./path/script.py
        
        xonsh script.xsh
        ./script.xsh
        ./path/script.xsh
        
        ./script   # shebang should has "env python" or "env xonsh"
        script     # script should be found in $PATH and shebang should has "env python" or "env xonsh"
        ```
        
        ## Example
        ```bash
        xpip install xontrib-argcomplete
        xontrib load argcomplete
        
        cd /tmp && git clone https://github.com/anki-code/xontrib-argcomplete
        cd xontrib-argcomplete/tests
        
        python proto.py <Tab>  # Suggestions: --help --proto -h
        ./proto.py --proto tt<Tab>  # Suggestions: http https
        ./proto.xsh --proto tt<Tab>  # Suggestions: http https
        ./proto --proto tt<Tab>  # Suggestions: http https
        
        sudo cp ./proto /bin/proto && sudo chmod +x /bin/proto
        proto --proto tt<Tab>  # Suggestions: http https
        sudo rm /bin/proto
        ```
        
        ## Known issues
        
        Current version supports Linux/Mac only.
        
        Files or paths with spaces in names is not supported now and completion will not be activated. PRs are welcome!
        
        ## Development
        * To switch on the debug mode run `$XONTRIB_ARGCOMPLETE_DEBUG = True`.
        * [Argcomplete environment variables](https://github.com/kislyuk/argcomplete/issues/319#issuecomment-693295017)
        * [Argcomplete documentation](https://kislyuk.github.io/argcomplete/)
        
Platform: any
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Unix Shell
Classifier: Topic :: System :: Shells
Classifier: Topic :: System :: System Shells
Classifier: Topic :: Terminals
Classifier: Topic :: System :: Networking
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
